Update https.md #36370
Merged
Update https.md #36370
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
Trott
reviewed
Dec 5, 2020
| @@ -288,6 +289,10 @@ The following additional `options` from [`tls.connect()`][] are also accepted: | |||
| string, it is automatically parsed with [`new URL()`][]. If it is a [`URL`][] | |||
| object, it will be automatically converted to an ordinary `options` object. | |||
|
|
|||
| `https.request()` returns an instance of the [`http.ClientRequest`][] | |||
| class. The `ClientRequest` instance is a writable stream. If one needs to | |||
There was a problem hiding this comment.
Pronouns are OK in our docs, so if you want to use you instead of one, that would be fine:
Suggested change
| class. The `ClientRequest` instance is a writable stream. If one needs to | |
| class. The `ClientRequest` instance is a writable stream. If you need to |
Trott
reviewed
Dec 5, 2020
Comment on lines
+292
to
+295
| `https.request()` returns an instance of the [`http.ClientRequest`][] | ||
| class. The `ClientRequest` instance is a writable stream. If one needs to | ||
| upload a file with a POST request, then write to the `ClientRequest` object. | ||
|
|
There was a problem hiding this comment.
Do we need any of this information in the text if it's been added to line 278 above? Maybe the paragraph can go but the other addition can stay?
Suggested change
| `https.request()` returns an instance of the [`http.ClientRequest`][] | |
| class. The `ClientRequest` instance is a writable stream. If one needs to | |
| upload a file with a POST request, then write to the `ClientRequest` object. |
There was a problem hiding this comment.
This paragraph was copied from http.request, includes the use of 'one'. All I did was add a single letter 's' to 'http':
https://github.com/nodejs/node/blob/master/doc/api/http.md#httprequesturl-options-callback
Trott
approved these changes
Dec 5, 2020
PoojaDurgad
approved these changes
Dec 17, 2020
aduh95
added
the
author ready
Add missing topic about what https.request() returns. PR-URL: nodejs#36370 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Pooja D P <Pooja.D.P@ibm.com>
|
Landed in 9df3b76 🎉 Thanks for the contribution. |
danielleadams
pushed a commit
that referenced
this pull request
Jan 12, 2021
Add missing topic about what https.request() returns. PR-URL: #36370 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Pooja D P <Pooja.D.P@ibm.com>
Merged
targos
pushed a commit
that referenced
this pull request
May 1, 2021
Add missing topic about what https.request() returns. PR-URL: #36370 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Pooja D P <Pooja.D.P@ibm.com>
Merged
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.
Add missing topic about what https.request() returns.