Document.evaluate(): document resultType default and mark optional parameters#44534
Open
gords2 wants to merge 1 commit into
Open
Document.evaluate(): document resultType default and mark optional parameters#44534gords2 wants to merge 1 commit into
gords2 wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #44495.
The
resultTypeparameter ofDocument.evaluate()is optional, but the page neither marked it optional nor documented its default value, so readers callingevaluate()with three arguments had no way to know what result type they'd get.Per the WHATWG DOM Standard, the WebIDL is:
So the three trailing parameters are all optional, and
type(documented here asresultType) defaults to0, which isXPathResult.ANY_TYPE.Changes:
resultType— added{{optional_inline}}and documented the default: "If omitted, it defaults toANY_TYPE(0)." (the issue's specific request).namespaceResolver— added{{optional_inline}}and noted it defaults tonull.result— added{{optional_inline}}and clarified that omitting it (not only passingnull) creates a newXPathResult.All three are optional in the spec, and a parameter can only be optional if every following one is too, so marking only
resultTypewould have been inconsistent.