Conversation
|
The HTTP 1.1 RFC actually uses 'Keep-Alive' when referring to the mechanism/functionality in general. I think it would be better to align with the RFC instead. |
|
For the instances that refer to the flag, keepAlive is right, but use backticks too: That will render like this: For instances that don't refer to the flag but instead refer to HTTP Keep-Alive: Keep-Alive is probably the way to go. /cc @nodejs/documentation |
|
In the HTTP 1.1 RFC it seems that
Should probably read more like:
@fhalde, although I'm not the one who raised the issue initially, I'd be happy to take this on if you're disinclined. |
|
@lance go ahead dude 😄 |
| keepAlive. | ||
|
|
||
| If you opt into using HTTP KeepAlive, you can create an Agent object | ||
| If you opt into using HTTP keepAlive, you can create an Agent object |
There was a problem hiding this comment.
By the way, the Agent seems to be:
- agent in lowercase
Agentwith backticks
There was a problem hiding this comment.
@yorkie I agree that there are some inconsistencies with Agent as well. Most of the time when we see capital-A, 'Agent' it's directly preceded by "HTTP". As in
The HTTP Agent is used for pooling sockets used in HTTP client requests.
When referred to this way, it seems like it should be referring to "http.Agent" (as code, and scoped to the module), instead of "HTTP Agent" (as a non-standard English language description of the object itself). What do you think?
There was a problem hiding this comment.
I guess a follow on question would be whether we should always scope the object name, so that whenever Agent appears in backticks, it is written as http.Agent.
There was a problem hiding this comment.
@lance I think that's typically only done if you were referencing a module other than the one the current documentation is for.
|
I am going to close this in favor of #10715. If that's not the best way to go about it, someone please let me know. :) |
Change
KeepAlivetokeepAliveRef #10567
Checklist