doc: adding note regarding http.get options #12124
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
jasnell
requested changes
Mar 29, 2017
doc/api/http.md
Outdated
| @@ -1539,6 +1539,8 @@ convenience method. The only difference between this method and | |||
| automatically. Note that response data must be consumed in the callback | |||
| for reasons stated in [`http.ClientRequest`][] section. | |||
|
|
|||
| Note: The `options` properties are copied via `util._extend()` which doesn't include the prototype. | |||
There was a problem hiding this comment.
Couple of style nits:
- Please wrap at 80 chars
s/Note:/*Note*:/- Rewording to something like the following is likely sufficient:
*Note*: The `options` object's "own" properties are copied when passed.
The fact that it uses util._extend() is an internal implementation detail that should not be worth documenting and could change at any point in the future)
There was a problem hiding this comment.
I'd like to avoid scare quotes in our docs if possible. Maybe this?:
*Note*: Properties inherited from the `options` object prototype chain are ignored.
Might it be better as part of the explanation of options and not a special note at the bottom?
* `options` {Object | string} Accepts the same `options` as
[`http.request()`][], with the `method` always set to `GET`.
Properties that are inherited from the prototype are ignored.
Also: Should this note be added to all relevant functions and not just .get()?
@nodejs/documentation
There was a problem hiding this comment.
Okay – added the changes.
Extra notes that options doesn't include the prototype when copied #12092
raphaelokon
changed the title
lpinca
approved these changes
Mar 31, 2017
|
@jasnell Do you still request your suggested changes? 1 & 3 should be fine now, not sure if I should add the |
raphaelokon
changed the title
jasnell
approved these changes
Mar 31, 2017
|
Landed in e1161a3 |
italoacasas
pushed a commit
to italoacasas/node
that referenced
this pull request
Apr 10, 2017
Extra notes that options doesn't include the prototype when copied Fixes: nodejs#12092 PR-URL: nodejs#12124 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
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.
This addresses #12092. Adds a note to
doc/api/http.mdthat clarifies thatoptionsdoesn't include the prototype.
Checklist
Affected core subsystem(s)
doc