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.

Sign up for GitHub

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

Jump to bottom

doc: add document for http.OutgoingMessage #37265

Closed
wants to merge 2 commits into from
Closed

doc: add document for http.OutgoingMessage #37265

wants to merge 2 commits into from

Conversation

Ayase-252
Copy link
Member

This PR adds document for http.OutgoingMessage, therefore, fix #33847.

I'm not sure what should be a part of public API, and assume that methods and properties without _ prefix. are part of public API.

The http.OutgoingMessage serves as the parent class of http.ClientRequest and http.ServerResponse. I copy-and-pasted many document from them.

@Ayase-252
doc: add document for http.OutgoingMessage
6641764 
OutgoingMessage is a very old feature which is exported
to public in http module dated to v0.1.x. But
it is not documented at all.

This commit adds document for http.OutgogingMessage.

Fixes: nodejs#33847
@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. http Issues or PRs related to the http subsystem. labels Feb 7, 2021
@PoojaDurgad
Copy link
Contributor

@nodejs/documentation

marsonya
marsonya requested changes Feb 24, 2021
View reviewed changes
Copy link
Member

@marsonya marsonya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Grammer fixes

doc/api/http.md Outdated Show resolved Hide resolved
doc/api/http.md Outdated Show resolved Hide resolved
doc/api/http.md Outdated Show resolved Hide resolved
marsonya
marsonya reviewed Feb 24, 2021
View reviewed changes
Copy link
Member

@marsonya marsonya left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These suggestions simply improve the grammar.
@jasnell, are these changes necessary or may be ignored?

doc/api/http.md Outdated Show resolved Hide resolved
doc/api/http.md Outdated Show resolved Hide resolved
doc/api/http.md Outdated Show resolved Hide resolved
doc/api/http.md Outdated Show resolved Hide resolved
doc/api/http.md Outdated Show resolved Hide resolved
doc/api/http.md Outdated Show resolved Hide resolved
doc/api/http.md Outdated Show resolved Hide resolved
doc/api/http.md Outdated Show resolved Hide resolved
doc/api/http.md Outdated Show resolved Hide resolved
doc/api/http.md Outdated Show resolved Hide resolved
@jasnell
Copy link
Member

jasnell commented Feb 24, 2021

I would apply the suggestions. Grammar improvements are always a good thing ;)

@Ayase-252
Copy link
Member Author

@marsonya Thank you for reviewing, I will process your suggestions tonight. (GMT+8)

benjamingr pushed a commit that referenced this pull request Mar 10, 2021
@Ayase-252 @benjamingr
doc: add document for http.OutgoingMessage
53b673e 
OutgoingMessage is a very old feature which is exported
to public in http module dated to v0.1.x. But
it is not documented at all.

This commit adds document for http.OutgogingMessage.

Fixes: #33847

PR-URL: #37265
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Robert Nagy <ronagy@icloud.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
benjamingr pushed a commit that referenced this pull request Mar 10, 2021
@Ayase-252 @benjamingr
doc: fix grammar errors in http document
648696b 
PR-URL: #37265
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Robert Nagy <ronagy@icloud.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
@benjamingr
Copy link
Member

Landed in c347f23...648696b 🎉

@benjamingr benjamingr closed this Mar 10, 2021
@Ayase-252 Ayase-252 deleted the doc/http-outgoing-message branch March 11, 2021 02:22
@danielleadams
Copy link
Contributor

I'm having trouble landing this in this week's 15.x because of a linting error here: 53b673e#diff-d692ac4524379ec6a1201165e8ff8d3267c8130e07014e8221ebf7e6f80c6641R3144.

This is the error I get locally:

doc/api/http.md
  3119:1-3119:41  warning  Found unused definition  no-unused-definitions  remark-lint

⚠ 1 warning
make: *** [tools/.mdlintstamp] Error 1

I tried to switch . for _, but I'm getting a "no link found" error - I've opened an issue #37759, and I'm going to mark this as dont-land-on-v15.x for now.

@danielleadams danielleadams mentioned this pull request Mar 15, 2021
Closed
1 task
danielleadams pushed a commit that referenced this pull request Mar 16, 2021
@Ayase-252 @danielleadams
doc: add document for http.OutgoingMessage
e5f7179 
OutgoingMessage is a very old feature which is exported
to public in http module dated to v0.1.x. But
it is not documented at all.

This commit adds document for http.OutgogingMessage.

Fixes: #33847

PR-URL: #37265
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Robert Nagy <ronagy@icloud.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
danielleadams pushed a commit that referenced this pull request Mar 16, 2021
@Ayase-252 @danielleadams
doc: fix grammar errors in http document
705bdfb 
PR-URL: #37265
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Robert Nagy <ronagy@icloud.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
@danielleadams danielleadams mentioned this pull request Mar 16, 2021
Merged
@Ayase-252 Ayase-252 restored the doc/http-outgoing-message branch April 5, 2021 14:32
@Ayase-252 Ayase-252 deleted the doc/http-outgoing-message branch April 5, 2021 14:32
targos pushed a commit that referenced this pull request May 30, 2021
@Ayase-252 @targos
doc: add document for http.OutgoingMessage
d162841 
OutgoingMessage is a very old feature which is exported
to public in http module dated to v0.1.x. But
it is not documented at all.

This commit adds document for http.OutgogingMessage.

Fixes: #33847

PR-URL: #37265
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Robert Nagy <ronagy@icloud.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
targos pushed a commit that referenced this pull request May 30, 2021
@Ayase-252 @targos
doc: fix grammar errors in http document
8e3322c 
PR-URL: #37265
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Robert Nagy <ronagy@icloud.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
targos pushed a commit that referenced this pull request Jun 5, 2021
@Ayase-252 @targos
doc: add document for http.OutgoingMessage
587c3dd 
OutgoingMessage is a very old feature which is exported
to public in http module dated to v0.1.x. But
it is not documented at all.

This commit adds document for http.OutgogingMessage.

Fixes: #33847

PR-URL: #37265
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Robert Nagy <ronagy@icloud.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
targos pushed a commit that referenced this pull request Jun 5, 2021
@Ayase-252 @targos
doc: fix grammar errors in http document
e5e823d 
PR-URL: #37265
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Robert Nagy <ronagy@icloud.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
@targos targos mentioned this pull request Jun 6, 2021
Merged
targos pushed a commit that referenced this pull request Jun 11, 2021
@Ayase-252 @targos
doc: add document for http.OutgoingMessage
19e8ae4 
OutgoingMessage is a very old feature which is exported
to public in http module dated to v0.1.x. But
it is not documented at all.

This commit adds document for http.OutgogingMessage.

Fixes: #33847

PR-URL: #37265
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Robert Nagy <ronagy@icloud.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
targos pushed a commit that referenced this pull request Jun 11, 2021
@Ayase-252 @targos
doc: fix grammar errors in http document
9320000 
PR-URL: #37265
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Robert Nagy <ronagy@icloud.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@marsonya marsonya marsonya approved these changes

@aymen94 aymen94 aymen94 approved these changes

@ronag ronag ronag approved these changes

@benjamingr benjamingr benjamingr approved these changes

@jasnell jasnell jasnell approved these changes

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. http Issues or PRs related to the http subsystem.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

document http.OutgoingMessage
9 participants
@Ayase-252 @PoojaDurgad @jasnell @benjamingr @danielleadams @ronag @aymen94 @marsonya @nodejs-github-bot