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: response.write ignores body in some cases #12314

Closed
wants to merge 1 commit into from
Closed

doc: response.write ignores body in some cases #12314

wants to merge 1 commit into from

Conversation

krydos
Copy link
Contributor

@krydos krydos commented Apr 10, 2017

Fixes: #8057

Hi guys. I hope it is ok to take a stalled PR (#8992) and finally close the issue.

Please feel free to close it, if it is something wrong.

What is done here, is updated doc for http and response.write in particular with information that body is ignored in case of HEAD request.

Checklist
Affected core subsystem(s)

doc, http

@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 Apr 10, 2017
@addaleax
Copy link
Member

I hope it is ok to take a stalled PR (#8992) and finally close the issue.

It definitely is. :)

Trott
Trott approved these changes Apr 12, 2017
View reviewed changes
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. Left a bunch of nits. If you can address them, great. If not, maybe the person landing this PR can. And if not, then someone can do it as an easy subsequent PR. Whatever, everyone wins!

doc/api/http.md Outdated
@@ -1161,6 +1161,9 @@ it will switch to implicit header mode and flush the implicit headers.
This sends a chunk of the response body. This method may
be called multiple times to provide successive parts of the body.

Note that in `http` module, the response body is omitted when the request is a
Copy link
Member

Choose a reason for hiding this comment

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

Nit: Add "the":

in the http module

doc/api/http.md Outdated
@@ -1161,6 +1161,9 @@ it will switch to implicit header mode and flush the implicit headers.
This sends a chunk of the response body. This method may
be called multiple times to provide successive parts of the body.

Note that in `http` module, the response body is omitted when the request is a
HEAD. Similarly, The `204` and `304` responses MUST NOT include a message body.
Copy link
Member

Choose a reason for hiding this comment

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

Nit: HEAD -> HEAD request (Yeah, it's repetitive, but I think that clarity is warranted here and not particularly awkward.)

Nit: The -> the

Nit: I don't think we do ALL CAPS for emphasis in the docs. MUST NOT -> to _must not_ which will render as italics.

@krydos
Copy link
Contributor Author

krydos commented Apr 12, 2017

@Trott thank you for the feedback. Pushed new changes.

@Trott
Copy link
Member

Trott commented Apr 12, 2017

LGTM

@benjamingr
Copy link
Member

Landed in bd7e0a3 - thanks for the contribution @krydos !

@benjamingr benjamingr closed this Apr 14, 2017
benjamingr pushed a commit that referenced this pull request Apr 14, 2017
@krydos
doc: response.write ignores body in some cases
bd7e0a3 
PR-URL: #12314
Fixes: #8057
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Daijiro Wachi <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
@krydos krydos deleted the http-doc-head-request branch April 14, 2017 18:47
evanlucas pushed a commit that referenced this pull request Apr 25, 2017
@krydos @evanlucas
doc: response.write ignores body in some cases
3e32361 
PR-URL: #12314
Fixes: #8057
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Daijiro Wachi <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
@evanlucas evanlucas mentioned this pull request May 1, 2017
Merged
evanlucas pushed a commit that referenced this pull request May 1, 2017
@krydos @evanlucas
doc: response.write ignores body in some cases
5128c2f 
PR-URL: #12314
Fixes: #8057
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Daijiro Wachi <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
evanlucas pushed a commit that referenced this pull request May 2, 2017
@krydos @evanlucas
doc: response.write ignores body in some cases
e2d66ab 
PR-URL: #12314
Fixes: #8057
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Daijiro Wachi <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
MylesBorins pushed a commit that referenced this pull request May 15, 2017
@krydos @MylesBorins
doc: response.write ignores body in some cases
9d2a5fb 
PR-URL: #12314
Fixes: #8057
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Daijiro Wachi <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
MylesBorins pushed a commit that referenced this pull request May 18, 2017
@krydos @MylesBorins
doc: response.write ignores body in some cases
3c1bd05 
PR-URL: #12314
Fixes: #8057
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Daijiro Wachi <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
@MylesBorins MylesBorins mentioned this pull request May 23, 2017
Merged
andrew749 pushed a commit to michielbaird/node that referenced this pull request Jul 19, 2017
@krydos @andrew749
doc: response.write ignores body in some cases
1ec0028 
PR-URL: nodejs/node#12314
Fixes: nodejs/node#8057
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Daijiro Wachi <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
@snyk-bot snyk-bot mentioned this pull request Mar 18, 2020
Open
@snyk-bot snyk-bot mentioned this pull request Apr 1, 2020
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jasnell jasnell jasnell approved these changes

@Trott Trott Trott approved these changes

@addaleax addaleax addaleax approved these changes

@lpinca lpinca lpinca approved these changes

@watilde watilde watilde approved these changes

@cjihrig cjihrig cjihrig 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.

Suggestion: http doc should mention special handling for HEAD and 304
10 participants
@krydos @addaleax @Trott @benjamingr @jasnell @lpinca @watilde @cjihrig @MylesBorins @nodejs-github-bot