doc: clarify http.request language #2415
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
Improve messaging for http.request's host and hostname parameters, as per nodejs/node-v0.x-archive#8990. I can't even count the number of times I've looked at the http docs to see whether host or hostname lets you include a port for http.request. The current language in the docs says that the host parameter is "A domain name or IP address of the server to issue the request to. Defaults to 'localhost'," and described the hostname parameter with "To support url.parse() hostname is preferred over host." The host description actually fits the hostname parameter better, and it seems like the host description needs to say something about allowing a port. Signed-off-by: Eli Skeggs <skeggse@gmail.com>
|
Related: #2271 |
|
I wrote that last change to these docs, and based on this line I interpreted the |
|
I'm pretty sure they weren't at one point. I haven't been keeping up with Node, and just migrated my PR from forever ago at the request of the joyent/node maintainers. |
|
If someone discovers that this PR is actually valid or something, feel free to comment. |
This was referenced Sep 4, 2020
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.
Improve messaging for
http.request'shostandhostnameparameters, as per nodejs/node-v0.x-archive#8990. I can't even count the number of times I've looked at the http docs to see whetherhostorhostnamelets you include a port forhttp.request.The current language in the docs says that the host parameter is "A domain name or IP address of the server to issue the request to. Defaults to 'localhost'," and described the hostname parameter with "To support url.parse() hostname is preferred over host." The host description actually fits the hostname parameter better, and it seems like the host description needs to say something about allowing a port.