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

Comments

Projects
None yet
4 participants
@safinaskar

safinaskar commented Aug 26, 2017

@mscdex mscdex added doc http labels Aug 26, 2017

@antoine-amara

This comment has been minimized.

Show comment
Hide comment
@antoine-amara

antoine-amara Aug 31, 2017

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.

Contributor

antoine-amara commented Aug 31, 2017

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

This comment has been minimized.

Show comment
Hide comment
@benjamingr

benjamingr Aug 31, 2017

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.

Member

benjamingr commented Aug 31, 2017

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

This comment has been minimized.

Show comment
Hide comment
@antoine-amara

antoine-amara Aug 31, 2017

Contributor

Thanks for your advises :)

Contributor

antoine-amara commented Aug 31, 2017

Thanks for your advises :)

antoine-amara added a commit to antoine-amara/node that referenced this issue Sep 3, 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.

Fixes: nodejs#15048

antoine-amara added a commit to antoine-amara/node that referenced this issue Sep 4, 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.

Fixes: nodejs#15048

antoine-amara added a commit to antoine-amara/node that referenced this issue Sep 7, 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.

Fixes: nodejs#15048

antoine-amara added a commit to antoine-amara/node that referenced this issue Sep 7, 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.

Fixes: nodejs#15048

antoine-amara added a commit to antoine-amara/node that referenced this issue Sep 13, 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.

Fixes: nodejs#15048

antoine-amara added a commit to antoine-amara/node that referenced this issue Sep 14, 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.

Fixes: nodejs#15048

@jasnell jasnell closed this in ca2c73c Sep 15, 2017

addaleax added a commit to addaleax/ayo that referenced this issue Sep 17, 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/node#15163
Fixes: nodejs/node#15048
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>

jasnell added a commit that referenced this issue Sep 20, 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: #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

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/node#15163
Fixes: nodejs/node#15048
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>

decareano pushed a commit to decareano/node that referenced this issue Sep 22, 2017

Marcelo Gobelli
formatting fix and scar deleted
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

decareano pushed a commit to decareano/node that referenced this issue Oct 7, 2017

Marcelo Gobelli
formatting fix and scar deleted
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