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

http.ClientRequest documentation inconsistencies (again) #15048

Closed
safinaskar opened this issue Aug 26, 2017 · 3 comments
Closed

http.ClientRequest documentation inconsistencies (again) #15048

safinaskar opened this issue Aug 26, 2017 · 3 comments
Labels
doc Issues and PRs related to the documentations. http Issues or PRs related to the http subsystem.

Comments

@safinaskar
Copy link

It seems #5717 is still not fixed in online docs available at https://nodejs.org/dist/latest-v8.x/docs/api/http.html#http_class_http_clientrequest .

@mscdex mscdex added doc Issues and PRs related to the documentations. http Issues or PRs related to the http subsystem. labels Aug 26, 2017
@antoine-amara
Copy link
Contributor

I'm new and I want to contribute, I think I can take care of this issue, I read the guidelines. I will try to submit a pull request ASAP.

@benjamingr
Copy link
Member

Hey @antoine-amara - thank you so much for stepping up.

The relevant file for the changes are in https://github.com/nodejs/node/blob/master/doc/api/http.md

The next step forward for you would be to fork the repository, clone it, make the changes on your computer, test them, and make a pull request.

While this might look like much it is explained in detail in https://github.com/nodejs/node/blob/master/CONTRIBUTING.md

If you have any specific questions or are stuck on it - please feel free to ping me (@benjamingr) directly.

@antoine-amara
Copy link
Contributor

Thanks for your advises :)

antoine-amara added a commit to antoine-amara/node that referenced this issue Sep 14, 2017
fix documentation for methods getHeader, setHeader and removeHeader
for http.ClientRequest class. The documentation said these functions
can be called but they're wasn't describe into the API description yet.

add parameters and general description for each methods.

Fixes: nodejs#15048
addaleax pushed a commit to addaleax/ayo that referenced this issue Sep 17, 2017
fix documentation for methods getHeader, setHeader and removeHeader
for http.ClientRequest class. The documentation said these functions
can be called but they're wasn't describe into the API description yet.

add parameters and general description for each methods.

PR-URL: nodejs/node#15163
Fixes: nodejs/node#15048
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
jasnell pushed a commit that referenced this issue Sep 20, 2017
fix documentation for methods getHeader, setHeader and removeHeader
for http.ClientRequest class. The documentation said these functions
can be called but they're wasn't describe into the API description yet.

add parameters and general description for each methods.

PR-URL: #15163
Fixes: #15048
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Qard pushed a commit to Qard/ayo that referenced this issue Sep 21, 2017
fix documentation for methods getHeader, setHeader and removeHeader
for http.ClientRequest class. The documentation said these functions
can be called but they're wasn't describe into the API description yet.

add parameters and general description for each methods.

PR-URL: nodejs/node#15163
Fixes: nodejs/node#15048
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
decareano added a commit to decareano/node that referenced this issue Sep 22, 2017
doc: fix http.ClientRequest method descriptions

fix documentation for methods getHeader, setHeader and removeHeader
for http.ClientRequest class. The documentation said these functions
can be called but they're wasn't describe into the API description yet.

add parameters and general description for each methods.

PR-URL: nodejs#15163
Fixes: nodejs#15048
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>

assert: use Same-value equality in deepStrictEqual

PR-URL: nodejs#15398
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>

formatting fix and scar deleted
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. http Issues or PRs related to the http subsystem.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants