doc: improve description of urlObject.query

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 <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Michaël Zasso <[email protected]>
nodejs · Dec 20, 2016 · cd3b91b · cd3b91b
1 parent ff7d856
commit cd3b91b
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/doc/api/url.md b/doc/api/url.md
@@ -114,9 +114,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:
+The `query` property is either the query string without the leading ASCII
+question mark (`?`), or an object returned by the [`querystring`][] module's
+`parse()` method. Whether the `query` property is a string or object is
+determined by the `parseQueryString` argument passed to `url.parse()`.
 
 For example: `'query=string'` or `{'query': 'string'}`