doc: revise Style Guide #26176
Closed
doc: revise Style Guide #26176
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
richardlau
approved these changes
Feb 18, 2019
| * 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.
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.
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.
Trott
force-pushed
the
style-guide-revisions
branch
from
1fddfbc to
3f13552
Compare
Trott
added
the
author ready
BethGriggs
approved these changes
Feb 18, 2019
|
Landed in e4a3664 |
Trott
added a commit
to Trott/io.js
that referenced
this pull request
Feb 20, 2019
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 <[email protected]> Reviewed-By: Beth Griggs <[email protected]>
addaleax
pushed a commit
that referenced
this pull request
Feb 21, 2019
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 <[email protected]> Reviewed-By: Beth Griggs <[email protected]>
Merged
rvagg
pushed a commit
that referenced
this pull request
Feb 28, 2019
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 <[email protected]> Reviewed-By: Beth Griggs <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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