doc: add missing periods in documentation.md #20469
Conversation
|
Node.js Collaborators, please, add 👍 here if you approve fast-tracking. |
There was a problem hiding this comment.
Since it will be rendered without a line break, I wonder if it makes sense to remove the line break in the .md file too? Otherwise, what's to stop someone (probably me!) coming along in 6 months and opening a fast-track pull request to remove these "unnecessary" periods? :-D
|
Amended. |
There was a problem hiding this comment.
Separate PR for sure, but I would be all for shortening these blobs of text. For example, the first one would probably be more readable and effective like this:
Stability: 0 - Deprecated. Use of this feature may cause warnings to be emitted.
Backwards compatibility across major versions should not be expected.(The removed text just basically says what it is already adequately communicated by the word "Deprecated".)
That sort of change is likely to generate bike-shedding, though, so definitely separate PR. :-D
|
Landed in 2553377 |
PR-URL: #20469 Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
PR-URL: #20469 Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
PR-URL: #20469 Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passesOur MD-2-HTML converter replaces line breaks with spaces in these fragments so the result becomes less readable after that without periods.
Before this PR:
After this PR: