doc: add document for http.OutgoingMessage#37265

Closed

Ayase-252 wants to merge 2 commits intonodejs:masterfrom

Ayase-252:doc/http-outgoing-message

Member

Ayase-252 commented Feb 7, 2021

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.


          doc: add document for http.OutgoingMessage

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 added doc http labels

Contributor

PoojaDurgad commented Feb 8, 2021

@nodejs/documentation

jasnell approved these changes

View reviewed changes

marsonya requested changes

View reviewed changes

Member

marsonya left a comment

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 reviewed

View reviewed changes

Member

marsonya left a comment •

edited

Loading

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

Member

jasnell commented Feb 24, 2021

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

Member Author

Ayase-252 commented Feb 24, 2021

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


          doc: fix grammar errors in http document

f45e61e

marsonya approved these changes

View reviewed changes

aymen94 approved these changes

View reviewed changes

ronag approved these changes

View reviewed changes

benjamingr approved these changes

View reviewed changes

benjamingr pushed a commit that referenced this pull request


          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


          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>

Member

benjamingr commented Mar 10, 2021

Landed in c347f23...648696b 🎉

benjamingr closed this

Ayase-252 deleted the doc/http-outgoing-message branch

March 11, 2021 02:22

Contributor

danielleadams commented Mar 15, 2021

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 added the dont-land-on-v15.x label

danielleadams mentioned this pull request

doc: linting error on docs/api/http.md #37759

Closed

1 task

danielleadams removed the dont-land-on-v15.x label

danielleadams pushed a commit that referenced this pull request


          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


          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 mentioned this pull request

v15.12.0 proposal #37766

Merged

Ayase-252 restored the doc/http-outgoing-message branch

April 5, 2021 14:32

Ayase-252 deleted the doc/http-outgoing-message branch

April 5, 2021 14:32

targos pushed a commit that referenced this pull request


          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


          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


          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


          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 mentioned this pull request

v14.17.1 release proposal #38948

Merged

targos pushed a commit that referenced this pull request


          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


          doc: fix grammar errors in http document

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

jasnell jasnell approved these changes

benjamingr benjamingr approved these changes

ronag ronag approved these changes

marsonya marsonya approved these changes

+1 more reviewer

aymen94 aymen94 approved these changes

Labels

doc http