doc: improve description of urlObject.query #9625
Closed
Conversation
This file contains 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
nodejs-github-bot
added
doc
Trott
requested changes
Nov 16, 2016
| @@ -115,8 +115,10 @@ No decoding of the `path` is performed. | |||
| ### urlObject.query | |||
|
|
|||
| The `query` property is either the "params" portion of the query string ( | |||
| everything *except* the leading ASCII question mark (`?`), or an object | |||
| returned by the [`querystring`][] module's `parse()` method: | |||
| everything *except* the leading ASCII question mark (`?`) ), or an object | |||
There was a problem hiding this comment.
How about we rephrase that first sentence to make it more concise and eliminate the nested parentheses:
The `query` property is either the query string without the leading question
mark (`?`) or an object returned by the [`querystring`][] module's `parse`
method.
The description of urlObject.query is ambiguous about when it's an object vs when it's a string. Added a sentence pointing to the option that determines this in url.parse(). Also fixed the missing parentheses in the first sentence by rewording it to avoid nested parentheses.
rahatarmanahmed
force-pushed
the
docs-urlobject-query
branch
from
33bd4ac to
9c92e91
Compare
|
I think that's a good idea. PR is updated w/ changes. |
Trott
approved these changes
Nov 16, 2016
cjihrig
approved these changes
Nov 16, 2016
jasnell
approved these changes
Nov 18, 2016
targos
approved these changes
Nov 19, 2016
|
Landed in 8f05611. Thanks! |
targos
pushed a commit
that referenced
this pull request
Nov 19, 2016
The description of urlObject.query is ambiguous about when it's an object vs when it's a string. Added a sentence pointing to the option that determines this in url.parse(). Also fixed the missing parentheses in the first sentence by rewording it to avoid nested parentheses. PR-URL: #9625 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com>
addaleax
pushed a commit
that referenced
this pull request
Nov 22, 2016
The description of urlObject.query is ambiguous about when it's an object vs when it's a string. Added a sentence pointing to the option that determines this in url.parse(). Also fixed the missing parentheses in the first sentence by rewording it to avoid nested parentheses. PR-URL: #9625 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Dec 20, 2016
The description of urlObject.query is ambiguous about when it's an object vs when it's a string. Added a sentence pointing to the option that determines this in url.parse(). Also fixed the missing parentheses in the first sentence by rewording it to avoid nested parentheses. PR-URL: #9625 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Dec 21, 2016
The description of urlObject.query is ambiguous about when it's an object vs when it's a string. Added a sentence pointing to the option that determines this in url.parse(). Also fixed the missing parentheses in the first sentence by rewording it to avoid nested parentheses. PR-URL: #9625 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com>
Merged
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.
Checklist
Affected core subsystem(s)
doc
Description of change
There's a bit of a disconnect in the description of
urlObject.query. It says it can be either an object or string, but doesn't explain the ambiguity. Added a sentence pointing to the option that determines this in url.parse().Also fixed a missing parentheses.