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: wrap and punctuate YAML description text #25419

Closed
wants to merge 1 commit into from

Conversation

@sam-github
Copy link
Member

commented Jan 9, 2019

stream.md was the only YAML in doc/api that was using > for line
continuation, and only used it for a few descriptions, most used the
same wrapping style the rest of the documentation does.

Also added punctuation and capitialization to a few description
sentences.

Fixes: #25413 (comment)

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines
doc: wrap and punctuate YAML description text
stream.md was the only YAML in doc/api that was using `>` for line
continuation, and only used it for a few descriptions, most used the
same wrapping style the rest of the documentation does.

Also added punctuation and capitialization to a few description
sentences.

Fixes: #25413 (comment)

@sam-github sam-github requested a review from mcollina Jan 9, 2019

@mcollina
Copy link
Member

left a comment

LGTM

@vsemozhetbyt

This comment has been minimized.

Copy link
Contributor

commented Jan 9, 2019

Node.js Collaborators, please, add 👍 here if you approve fast-tracking.

@sam-github

This comment has been minimized.

Copy link
Member Author

commented Jan 9, 2019

Landed in c2d8a54

@sam-github sam-github closed this Jan 9, 2019

@sam-github sam-github deleted the sam-github:wrap-description-yaml branch Jan 9, 2019

sam-github added a commit that referenced this pull request Jan 9, 2019
doc: wrap and punctuate YAML description text
stream.md was the only YAML in doc/api that was using `>` for line
continuation, and only used it for a few descriptions, most used the
same wrapping style the rest of the documentation does.

Also added punctuation and capitialization to a few description
sentences.

Fixes: #25413 (comment)

PR-URL: #25419
Fixes: #25413
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
addaleax added a commit that referenced this pull request Jan 14, 2019
doc: wrap and punctuate YAML description text
stream.md was the only YAML in doc/api that was using `>` for line
continuation, and only used it for a few descriptions, most used the
same wrapping style the rest of the documentation does.

Also added punctuation and capitialization to a few description
sentences.

Fixes: #25413 (comment)

PR-URL: #25419
Fixes: #25413
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
@BridgeAR BridgeAR referenced this pull request Jan 16, 2019
BridgeAR added a commit to BridgeAR/node that referenced this pull request Jan 16, 2019
doc: wrap and punctuate YAML description text
stream.md was the only YAML in doc/api that was using `>` for line
continuation, and only used it for a few descriptions, most used the
same wrapping style the rest of the documentation does.

Also added punctuation and capitialization to a few description
sentences.

Fixes: nodejs#25413 (comment)

PR-URL: nodejs#25419
Fixes: nodejs#25413
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
@MylesBorins MylesBorins referenced this pull request Jan 24, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
6 participants
You can’t perform that action at this time.