References to an "KeepAlive" flag in the http.Agent constructor, when it is actually "keepAlive" #10567
Labels
doc
Issues and PRs related to the documentations.
good first issue
Issues that are suitable for first-time contributors.
http
Issues or PRs related to the http subsystem.
Comments
|
@papiro would you be interested in making a contribution to the documentation that fixes this? It would be greatly appreciated. The actual file that is used to generate that documentation can be found at https://github.com/nodejs/node/blob/master/doc/api/http.md. Feel free to ping me if you have any questions on making this change. Thanks for bringing it to our attention! |
gibfahn
added
the
good first issue
|
Adding the |
|
I'll give it a shot :) Thanks! |
|
To be honest, I'm trying to grok what the documentation is actually trying to say and I just don't get it. This line specifically:
Is it referring to HTTP clients with an agent that has the Also, this line:
Is it referring again to the option to the Any clarity on these would be greatly appreciated. |
|
Is this stilla point? |
|
The meaning of what is being said is still unclear to me, yes.
Get Outlook for Android<https://aka.ms/ghei36>
On Mon, Jan 9, 2017 at 3:13 PM -0500, "Martina Kraus" <notifications@github.com<mailto:notifications@github.com>> wrote:
Is this stilla point?
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub<#10567 (comment)>, or mute the thread<https://github.com/notifications/unsubscribe-auth/AHxBhMCwBAn4gwFQaQkHM2RWGmpF2u4hks5rQpTwgaJpZM4LYxSC>.
|
|
Have you seen #10715, in process of addressing this? |
|
Awesome! Looking forward to reading it ☺
Get Outlook for Android<https://aka.ms/ghei36>
On Mon, Jan 9, 2017 at 4:08 PM -0500, "Sam Roberts" <notifications@github.com<mailto:notifications@github.com>> wrote:
Have you seen #10715<#10715>, in process of addressing this?
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub<#10567 (comment)>, or mute the thread<https://github.com/notifications/unsubscribe-auth/AHxBhK04QCqGiWd3w3OvrowfCv1wORi6ks5rQqHCgaJpZM4LYxSC>.
|
lance
added a commit
that referenced
this issue
Jan 25, 2017
The HTTP Keep-Alive text was inconsistent. These changes follow the following rules * When referring to flag used in code, it should always be written using backticks and in camel case. E.g. `keepAlive`. * When referring to the mechanism Keep-Alive functionality as described in the HTTP 1.1 RFC, it is written as 'HTTP Keep-Alive', without the use of backticks. * When referring to the request header, it should always use backticks and be written as `Connection: keep-alive`. This commit also includes some changes to how `http.Agent` is referenced. When `Agent` is used as a reference to an object or instance, backticks should always be used. And lastly, the documentation about `Agent` behavior around HTTP Keep-Alive has been clarified and improved. Fixes: #10567 PR-URL: #10715 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
targos
pushed a commit
that referenced
this issue
Jan 28, 2017
The HTTP Keep-Alive text was inconsistent. These changes follow the following rules * When referring to flag used in code, it should always be written using backticks and in camel case. E.g. `keepAlive`. * When referring to the mechanism Keep-Alive functionality as described in the HTTP 1.1 RFC, it is written as 'HTTP Keep-Alive', without the use of backticks. * When referring to the request header, it should always use backticks and be written as `Connection: keep-alive`. This commit also includes some changes to how `http.Agent` is referenced. When `Agent` is used as a reference to an object or instance, backticks should always be used. And lastly, the documentation about `Agent` behavior around HTTP Keep-Alive has been clarified and improved. Fixes: #10567 PR-URL: #10715 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
italoacasas
pushed a commit
to italoacasas/node
that referenced
this issue
Jan 30, 2017
The HTTP Keep-Alive text was inconsistent. These changes follow the following rules * When referring to flag used in code, it should always be written using backticks and in camel case. E.g. `keepAlive`. * When referring to the mechanism Keep-Alive functionality as described in the HTTP 1.1 RFC, it is written as 'HTTP Keep-Alive', without the use of backticks. * When referring to the request header, it should always use backticks and be written as `Connection: keep-alive`. This commit also includes some changes to how `http.Agent` is referenced. When `Agent` is used as a reference to an object or instance, backticks should always be used. And lastly, the documentation about `Agent` behavior around HTTP Keep-Alive has been clarified and improved. Fixes: nodejs#10567 PR-URL: nodejs#10715 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
italoacasas
pushed a commit
to italoacasas/node
that referenced
this issue
Jan 30, 2017
The HTTP Keep-Alive text was inconsistent. These changes follow the following rules * When referring to flag used in code, it should always be written using backticks and in camel case. E.g. `keepAlive`. * When referring to the mechanism Keep-Alive functionality as described in the HTTP 1.1 RFC, it is written as 'HTTP Keep-Alive', without the use of backticks. * When referring to the request header, it should always use backticks and be written as `Connection: keep-alive`. This commit also includes some changes to how `http.Agent` is referenced. When `Agent` is used as a reference to an object or instance, backticks should always be used. And lastly, the documentation about `Agent` behavior around HTTP Keep-Alive has been clarified and improved. Fixes: nodejs#10567 PR-URL: nodejs#10715 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
jasnell
pushed a commit
that referenced
this issue
Mar 8, 2017
The HTTP Keep-Alive text was inconsistent. These changes follow the following rules * When referring to flag used in code, it should always be written using backticks and in camel case. E.g. `keepAlive`. * When referring to the mechanism Keep-Alive functionality as described in the HTTP 1.1 RFC, it is written as 'HTTP Keep-Alive', without the use of backticks. * When referring to the request header, it should always use backticks and be written as `Connection: keep-alive`. This commit also includes some changes to how `http.Agent` is referenced. When `Agent` is used as a reference to an object or instance, backticks should always be used. And lastly, the documentation about `Agent` behavior around HTTP Keep-Alive has been clarified and improved. Fixes: #10567 PR-URL: #10715 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
MylesBorins
pushed a commit
that referenced
this issue
Mar 9, 2017
The HTTP Keep-Alive text was inconsistent. These changes follow the following rules * When referring to flag used in code, it should always be written using backticks and in camel case. E.g. `keepAlive`. * When referring to the mechanism Keep-Alive functionality as described in the HTTP 1.1 RFC, it is written as 'HTTP Keep-Alive', without the use of backticks. * When referring to the request header, it should always use backticks and be written as `Connection: keep-alive`. This commit also includes some changes to how `http.Agent` is referenced. When `Agent` is used as a reference to an object or instance, backticks should always be used. And lastly, the documentation about `Agent` behavior around HTTP Keep-Alive has been clarified and improved. Fixes: #10567 PR-URL: #10715 Reviewed-By: Sam Roberts <vieuxtech@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
In the version 7.3.0 documentation, in the page on http, in the first few paragraphs of the http.Agent section it makes references to a
KeepAliveflag in thehttp.Agentconstructor which you can specify as true if you'd like to keep unused sockets pooled. Admittedly this caused me a decent amount of confusion because of the case mismatch :)The text was updated successfully, but these errors were encountered: