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

doc: describe API ERR_INVALID_PROTOCOL context #27393

Closed
wants to merge 1 commit into from

Conversation

sam-github
Copy link
Contributor

ERR_INVALID_PROTOCOL docs should describe the API it relates to.

See: https://github.com/nodejs/node/pull/27390/files#r278246361

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

@nodejs-github-bot
Copy link
Collaborator

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. errors Issues and PRs related to JavaScript errors originated in Node.js core. labels Apr 24, 2019
@sam-github sam-github changed the title doc: describe the API ERR_INVALID_PROTOCOL is for doc: describe API ERR_INVALID_PROTOCOL context Apr 26, 2019
@sam-github
Copy link
Contributor Author

@nodejs/documentation trivial PR, could someone give this a review, please.

Note that protocols show up in the node API surface in several places. This error code is unrelated to TLS protocols, for example. The code should probably have had HTTP_ in its name, but its too late for that. I had to grep the source to figure out what protocol the error code referred to.

@sam-github
Copy link
Contributor Author

@nodejs/collaborators trivial PR, please give it a thumbs up

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. I suppose that (from the end-user perspective) it might also be triggered by http.get() and friends? Regardless, I wonder if we should remove this entirely in 13.x and replace with ERR_INVALID_OPT_VALUE.

@sam-github
Copy link
Contributor Author

Landed in dce8806

@sam-github sam-github closed this Apr 30, 2019
@sam-github sam-github deleted the doc-invalid-protocol branch April 30, 2019 15:45
sam-github added a commit that referenced this pull request Apr 30, 2019
ERR_INVALID_PROTOCOL docs should describe the API it relates to.

See: https://github.com/nodejs/node/pull/27390/files#r278246361

PR-URL: #27393
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
targos pushed a commit that referenced this pull request Apr 30, 2019
ERR_INVALID_PROTOCOL docs should describe the API it relates to.

See: https://github.com/nodejs/node/pull/27390/files#r278246361

PR-URL: #27393
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
@targos targos mentioned this pull request May 6, 2019
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. errors Issues and PRs related to JavaScript errors originated in Node.js core.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants