doc: wrap and punctuate YAML description text #25419
Closed
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
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)
nodejs-github-bot
added
doc
3 tasks
addaleax
approved these changes
Jan 9, 2019
vsemozhetbyt
approved these changes
Jan 9, 2019
|
Node.js Collaborators, please, add 👍 here if you approve fast-tracking. |
vsemozhetbyt
added
the
author ready
richardlau
approved these changes
Jan 9, 2019
|
Landed in c2d8a54 |
sam-github
added a commit
that referenced
this pull request
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) 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
pushed a commit
that referenced
this pull request
Jan 14, 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) 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>
Merged
BridgeAR
pushed a commit
to BridgeAR/node
that referenced
this pull request
Jan 16, 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: 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>
Merged
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.
stream.md was the only YAML in doc/api that was using
>for linecontinuation, 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), orvcbuild test(Windows) passes