Skip to content
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

Merged
merged 1 commit into from
Dec 26, 2020
Merged

Update https.md #36370

merged 1 commit into from
Dec 26, 2020

Conversation

mcgitty
Copy link
Contributor

@mcgitty mcgitty commented Dec 3, 2020

Add missing topic about what https.request() returns.

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. https Issues or PRs related to the https subsystem. labels Dec 3, 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
Copy link
Member

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:

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

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.

Copy link
Member

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?

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.

Copy link
Contributor Author

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':

https://github.com/nodejs/node/blob/master/doc/api/http.md#httprequesturl-options-callback

Copy link
Member

@Trott Trott left a 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.

@aduh95 aduh95 added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Dec 17, 2020
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>
@aduh95
Copy link
Contributor

aduh95 commented Dec 26, 2020

Landed in 9df3b76 🎉 Thanks for the contribution.

@aduh95 aduh95 merged commit 9df3b76 into nodejs:master Dec 26, 2020
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>
@danielleadams danielleadams mentioned this pull request Jan 12, 2021
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>
@danielleadams danielleadams mentioned this pull request May 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations. https Issues or PRs related to the https subsystem.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants