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: revise Style Guide #26176

Closed
wants to merge 1 commit into from

Conversation

Projects
None yet
4 participants
@Trott
Copy link
Member

commented Feb 18, 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.

Otherwise, a bunch of stylistic changes, mostly to keep things concise
and direct.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines
@richardlau
Copy link
Member

left a comment

Left some comments, neither of them are blocking.

Show resolved Hide resolved doc/STYLE_GUIDE.md Outdated
* 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.

This comment has been minimized.

Copy link
@richardlau

richardlau Feb 18, 2019

Member

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

This comment has been minimized.

Copy link
@Trott

Trott Feb 18, 2019

Author Member

I suppose at least this is an improvement because it actually mentions the YAML comments.

doc: revise Style Guide
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 Trott force-pushed the Trott:style-guide-revisions branch from 1fddfbc to 3f13552 Feb 18, 2019

@Trott

This comment has been minimized.

Copy link
Member Author

commented Feb 18, 2019

@Trott Trott added the author ready label Feb 18, 2019

@Trott

This comment has been minimized.

Copy link
Member Author

commented Feb 20, 2019

Landed in e4a3664

@Trott Trott closed this Feb 20, 2019

Trott added a commit to Trott/io.js that referenced this pull request Feb 20, 2019

doc: revise Style Guide
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>

addaleax added a commit that referenced this pull request Feb 21, 2019

doc: revise Style Guide
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>

@BridgeAR BridgeAR referenced this pull request Feb 26, 2019

Merged

v11.11.0 proposal #26322

rvagg added a commit that referenced this pull request Feb 28, 2019

doc: revise Style Guide
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.