-
Notifications
You must be signed in to change notification settings - Fork 30.1k
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: reorder deprecated tls docs #34687
Conversation
In other api docs, it seems that deprecated classes and methods are listed along with others, and marked as deprecated. In tls docs, deprecations were listed at the bottom of the document. This commit reorders them to what seems to be the standard, and corrects some links in doc/api/deprecations.md
cc @Trott |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This had been done intentionally to try to encourage that pattern throughout the other docs. I'd much rather see us go the other direction, moving deprecated APIs out to separate sections.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This had been done intentionally to try to encourage that pattern throughout the other docs. I'd much rather see us go the other direction, moving deprecated APIs out to separate sections.
Why do we want to do that? |
Frankly, to make deprecation easier to find, or easier to ignore. |
Easier to find: I don't think we should optimize for "I need to find all the deprecated functions in one place". I think we should optimize for "I need to know how this function works. I need to find it in a predictable place in the docs. I don't know that it's deprecated, or wouldn't think to look Someplace Else for deprecated functions." Easier to ignore: Valid, but similarly, I don't think it's what we should optimize for over "the method is where I expect to find it". The On balance, I support this change and halting any move to requiring deprecated APIs to be tucked away at the bottom of the docs. /ping @nodejs/documentation |
Doubt I'll have much luck winning folks over to my side ;-) ....won't block
In other api docs, it seems that deprecated classes and methods are listed along with others, and marked as deprecated. In tls docs, deprecations were listed at the bottom of the document. This commit reorders them to what seems to be the standard, and corrects some links in doc/api/deprecations.md PR-URL: #34687 Reviewed-By: Rich Trott <rtrott@gmail.com>
Landed in be360e2 |
In other api docs, it seems that deprecated classes and methods are listed along with others, and marked as deprecated. In tls docs, deprecations were listed at the bottom of the document. This commit reorders them to what seems to be the standard, and corrects some links in doc/api/deprecations.md PR-URL: #34687 Reviewed-By: Rich Trott <rtrott@gmail.com>
In other api docs, it seems that deprecated classes and methods are listed along with others, and marked as deprecated. In tls docs, deprecations were listed at the bottom of the document. This commit reorders them to what seems to be the standard, and corrects some links in doc/api/deprecations.md PR-URL: #34687 Reviewed-By: Rich Trott <rtrott@gmail.com>
In other api docs, it seems that deprecated classes and methods are listed along with others, and marked as deprecated. In tls docs, deprecations were listed at the bottom of the document. This commit reorders them to what seems to be the standard, and corrects some links in doc/api/deprecations.md PR-URL: #34687 Reviewed-By: Rich Trott <rtrott@gmail.com>
In other api docs, it seems that deprecated classes and methods are listed along with others, and marked as deprecated. In tls docs, deprecations were listed at the bottom of the document. This commit reorders them to what seems to be the standard, and corrects some links in doc/api/deprecations.md PR-URL: #34687 Reviewed-By: Rich Trott <rtrott@gmail.com>
In other api docs, it seems that deprecated classes and methods are
listed along with others, and marked as deprecated. In tls docs,
deprecations were listed at the bottom of the document. This commit
reorders them to what seems to be the standard, and corrects some links
in doc/api/deprecations.md
Checklist