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

Update v8.x docs for http request set timeout #25122

Conversation

jbunton-atlassian
Copy link
Contributor

@jbunton-atlassian jbunton-atlassian commented Dec 19, 2018

When upgrading from Node.js 8 to 10 I hit the behaviour change in #8895. This documentation update would have helped me find the problem faster :)

Also see #25121 for an update to the docs on master.

Thanks :)

Checklist

@nodejs-github-bot nodejs-github-bot added build Issues and PRs related to build files or the CI. doc Issues and PRs related to the documentations. meta Issues and PRs related to the general management of the project. tools Issues and PRs related to the tools directory. labels Dec 19, 2018
@mscdex
Copy link
Contributor

mscdex commented Dec 19, 2018

I think you meant to target the v8.x-staging branch instead?

@jbunton-atlassian jbunton-atlassian changed the base branch from master to v8.x-staging December 19, 2018 04:49
@jbunton-atlassian jbunton-atlassian force-pushed the update_v8.x_docs_for_http_request_setTimeout branch from ff3bdc0 to b1d62ee Compare December 19, 2018 04:50
@jbunton-atlassian
Copy link
Contributor Author

@mscdex so sorry! Indeed, I forgot to look at the diff 🤦‍♂️

@mscdex
Copy link
Contributor

mscdex commented Dec 19, 2018

I'm not sure adding this is worthwhile. We already have changelogs with both commit info and high-level change information as well as important API changes across versions in the most recent docs.

@jbunton-atlassian
Copy link
Contributor Author

It took me a few hours to find this. The current documentation for v8.x is wrong which meant I actually only found the issue through a git-bisect. I was hoping to save others the same effort.

@mscdex
Copy link
Contributor

mscdex commented Dec 19, 2018

I see, I was mainly referring to the part about 'Note that this behaviour changes in Node.js version 9 and higher.'

@jbunton-atlassian jbunton-atlassian deleted the update_v8.x_docs_for_http_request_setTimeout branch December 19, 2018 06:08
@jbunton-atlassian
Copy link
Contributor Author

jbunton-atlassian commented Dec 19, 2018

Ack... I'm failing at git today.

See #25123.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build Issues and PRs related to build files or the CI. doc Issues and PRs related to the documentations. meta Issues and PRs related to the general management of the project. tools Issues and PRs related to the tools directory.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants