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: wrong info for http deprecation #33779

Closed
mscdex opened this issue Jun 7, 2020 · 2 comments
Closed

doc: wrong info for http deprecation #33779

mscdex opened this issue Jun 7, 2020 · 2 comments
Labels
deprecations Issues and PRs related to deprecations. doc Issues and PRs related to the documentations. http Issues or PRs related to the http subsystem.

Comments

@mscdex
Copy link
Contributor

mscdex commented Jun 7, 2020

  • Version: v12.x, master
  • Platform: n/a
  • Subsystem: doc, http

DEP0133 which is about the deprecation for outgoingMessage.connection has two issues:

  • It's currently labeled as being doc-deprecated in v12.12.0 which is not true, it was done so in v13.0.0.

  • The deprecations documentation for v12.x (since v12.12.0) lists DEP0133, which should either be removed (because it's not deprecated in v12.x) or the correct (future major) version needs to be shown instead

@mscdex mscdex added http Issues or PRs related to the http subsystem. doc Issues and PRs related to the documentations. deprecations Issues and PRs related to deprecations. labels Jun 7, 2020
@Trott
Copy link
Member

Trott commented Jun 7, 2020

Since the documentation for 12.12.0 says it's deprecated, it is ipso facto doc-deprecated in 12.12.0.

And 12.12.0 came out about 10 days or so before 13.0.0.

Is the issue that doc-only deprecations were once treated as semver-major and so this wouldn't have been able to land in 12.12.0? If so, that was changed in February 2019 before the 12.0.0 release. See https://github.com/nodejs/node/blob/d8eef83757c263672832687ac7667927a7d0c059/doc/guides/collaborator-guide.md#deprecations:

Apply the notable change label to all pull requests that introduce
Documentation-Only Deprecations. Such deprecations have no impact on code
execution. Thus, they are not breaking changes (semver-major).

@mscdex
Copy link
Contributor Author

mscdex commented Jun 7, 2020

The PR that introduced the doc deprecation happened 6 months after that policy was changed and the PR was labeled as semver-major.

Another thing that makes it look like a mistake is that the PR linked to the actual commit was supposed to only be for a different doc deprecation, but the commit ended up having additional changes. I think if the intention was to keep the numbering system consistent with master, then the original PR should have been backported first because with that commit on v12.x the markdown there is now currently broken (the doc reference links are broken for DEP0133 in deprecations.md) as it was not a complete backport.

@mscdex mscdex closed this as completed Jun 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecations Issues and PRs related to deprecations. doc Issues and PRs related to the documentations. http Issues or PRs related to the http subsystem.
Projects
None yet
Development

No branches or pull requests

2 participants