-
Notifications
You must be signed in to change notification settings - Fork 30k
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: revise Style Guide #26176
doc: revise Style Guide #26176
Conversation
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.
Left some comments, neither of them are blocking.
* When using dashes, use [Em dashes][] ("—" or `Option+Shift+"-"` on macOS) | ||
surrounded by spaces, as per [The New York Times Manual of Style and Usage][]. | ||
* When documenting APIs, update the YAML comment associated with the API as | ||
appropriate. This is especially true when introducing or deprecating an API. |
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.
AFAIK we have no documentation on the YAML comments, so it's guesswork based on the existing YAML comments as to what should go in there when introducing a new API. Kind of falls under the general: #25548
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.
I suppose at least this is an improvement because it actually mentions the YAML comments.
Most important change here is to point people to the YAML material in the docs rather than the previous way we indicated versions that introduced or deprecated APIs. Remove contents about assets as we do not actually have any in the docs. Otherwise, a bunch of stylistic changes, mostly to keep things concise and direct.
1fddfbc
to
3f13552
Compare
Landed in e4a3664 |
Most important change here is to point people to the YAML material in the docs rather than the previous way we indicated versions that introduced or deprecated APIs. Remove contents about assets as we do not actually have any in the docs. Otherwise, a bunch of stylistic changes, mostly to keep things concise and direct. PR-URL: nodejs#26176 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Most important change here is to point people to the YAML material in the docs rather than the previous way we indicated versions that introduced or deprecated APIs. Remove contents about assets as we do not actually have any in the docs. Otherwise, a bunch of stylistic changes, mostly to keep things concise and direct. PR-URL: #26176 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Most important change here is to point people to the YAML material in the docs rather than the previous way we indicated versions that introduced or deprecated APIs. Remove contents about assets as we do not actually have any in the docs. Otherwise, a bunch of stylistic changes, mostly to keep things concise and direct. PR-URL: #26176 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Most important change here is to point people to the YAML material in
the docs rather than the previous way we indicated versions that
introduced or deprecated APIs.
Otherwise, a bunch of stylistic changes, mostly to keep things concise
and direct.
Checklist
make -j4 test
(UNIX), orvcbuild test
(Windows) passes