-
Notifications
You must be signed in to change notification settings - Fork 29.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update https.md #36370
Update https.md #36370
Conversation
@@ -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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pronouns are OK in our docs, so if you want to use you
instead of one
, that would be fine:
class. The `ClientRequest` instance is a writable stream. If one needs to | |
class. The `ClientRequest` instance is a writable stream. If you need to |
`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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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?
`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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This paragraph was copied from http.request, includes the use of 'one'. All I did was add a single letter 's' to 'http':
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM with or without my suggestions.
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. |
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>
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>
Add missing topic about what https.request() returns.