doc: fix http properties documented as methods - #12039
Closed
ahmadnassri wants to merge 2 commits into
Closed
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
- at 9772fb9 [`maxHeadersCount`][maxheaderscount] and [`timeout`][timeout] were erroneously changed to methods - `maxHeadersCount` was also listed to default to `1000` where it actually is [`2000`][default] [maxheaderscount]: https://github.com/nodejs/node/blob/e0a9ad1af244f8756a228a6d087b3a55ee4c0d14/lib/_http_server.js#L276 [timeout]: https://github.com/nodejs/node/blob/e0a9ad1af244f8756a228a6d087b3a55ee4c0d14/lib/_http_server.js#L273 [default]: https://github.com/nodejs/node/blob/e0a9ad1af244f8756a228a6d087b3a55ee4c0d14/lib/_http_server.js#L312
`server.timeout` is a property, not a method
Copy link
Copy Markdown
Contributor
|
@ahmadnassri Thank you for your contribution! A nit: it seems the message of the first commit violates line length requrements. Could you wrap the lines? And maybe it is better to clean out markdown link code. So the commit message can be something like this: doc: fix http properties documented as methods At 9772fb9 `maxHeadersCount` and `timeout` were erroneously changed to methods. `maxHeadersCount` was also listed to default to `1000` where it actually is `2000` Refs: https://github.com/nodejs/node/blob/e0a9ad1af244f8756a228a6d087b3a55ee4c0d14/lib/_http_server.js#L276 Refs: https://github.com/nodejs/node/blob/e0a9ad1af244f8756a228a6d087b3a55ee4c0d14/lib/_http_server.js#L273 Refs: https://github.com/nodejs/node/blob/e0a9ad1af244f8756a228a6d087b3a55ee4c0d14/lib/_http_server.js#L312 Or even like this (in the message of the landed commit there will be a link to this PR, so all your links will be available): doc: fix http properties documented as methods At 9772fb9 `maxHeadersCount` and `timeout` were erroneously changed to methods. `maxHeadersCount` was also listed to default to `1000` where it actually is `2000` |
Sorry, something went wrong.
lpinca
approved these changes
Mar 26, 2017
fhinkel
approved these changes
Mar 27, 2017
jasnell
approved these changes
Mar 27, 2017
jasnell
pushed a commit
that referenced
this pull request
Mar 27, 2017
* at 9772fb9 [`maxHeadersCount`][maxheaderscount] and [`timeout`][timeout] were erroneously changed to methods * `maxHeadersCount` was also listed to default to `1000` where it actually is [`2000`][default] [maxheaderscount]: https://github.com/nodejs/node/blob/e0a9ad1af244f8756a228a6d087b3a55ee4c0d14/lib/_http_server.js#L276 [timeout]: https://github.com/nodejs/node/blob/e0a9ad1af244f8756a228a6d087b3a55ee4c0d14/lib/_http_server.js#L273 [default]: https://github.com/nodejs/node/blob/e0a9ad1af244f8756a228a6d087b3a55ee4c0d14/lib/_http_server.js#L312 PR-URL: #12039 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
jasnell
pushed a commit
that referenced
this pull request
Mar 27, 2017
`server.timeout` is a property, not a method PR-URL: #12039 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Mar 28, 2017
* at 9772fb9 [`maxHeadersCount`][maxheaderscount] and [`timeout`][timeout] were erroneously changed to methods * `maxHeadersCount` was also listed to default to `1000` where it actually is [`2000`][default] [maxheaderscount]: https://github.com/nodejs/node/blob/e0a9ad1af244f8756a228a6d087b3a55ee4c0d14/lib/_http_server.js#L276 [timeout]: https://github.com/nodejs/node/blob/e0a9ad1af244f8756a228a6d087b3a55ee4c0d14/lib/_http_server.js#L273 [default]: https://github.com/nodejs/node/blob/e0a9ad1af244f8756a228a6d087b3a55ee4c0d14/lib/_http_server.js#L312 PR-URL: #12039 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Mar 28, 2017
`server.timeout` is a property, not a method PR-URL: #12039 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Merged
Copy link
Copy Markdown
Contributor
|
is this applicable to v6.x? |
Sorry, something went wrong.
3 tasks
Copy link
Copy Markdown
Member
|
Should this be backported to v6.x-staging? If yes please follow the guide and raise a backport PR, if no let me know or add the dont-land-on label. |
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
This is misleading, that link is referencing maxHeaderPairs which includes both keys and values, so 2000 pairs is 1000 headers. The docs at the moment are a bit misleading; you would expect to be able to send 2000 headers but anything after 1000 is silently dropped. |
Sorry, something went wrong.
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.
Checklist
Affected core subsystem(s)