doc: remove you and fixup note in stream.md
#14938
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
nodejs-github-bot
added
doc
TimothyGu
approved these changes
Aug 19, 2017
BridgeAR
approved these changes
Aug 19, 2017
lpinca
approved these changes
Aug 19, 2017
Trott
reviewed
Aug 19, 2017
doc/api/stream.md
Outdated
|
|
||
| Note: `_final()` **must not** be called directly. It MAY be implemented | ||
| *Note*: `_final()` **must not** be called directly. It MAY be implemented |
There was a problem hiding this comment.
Optional nit: We probably want to avoid ALL CAPS. Probably best to emulate the styling of must not here for may. Then this line will have "only" two typographies for emphasis (italics and bold), and not three.
There was a problem hiding this comment.
Second optional nit: Is this really a "note"? Seems like it could just be a sentence by itself without prepending Note:.
There was a problem hiding this comment.
The uppercase variant was most likely derived from RFC2119, which is used in a lot of non-RFC documents. (I am not saying we SHOULD follow that.)
±0 on keeping it a Note.
Trott
approved these changes
Aug 19, 2017
cjihrig
approved these changes
Aug 20, 2017
hiroppy
approved these changes
Aug 20, 2017
tniessen
approved these changes
Aug 20, 2017
refack
approved these changes
Aug 20, 2017
jasnell
added a commit
that referenced
this pull request
Aug 21, 2017
PR-URL: #14938 Reviewed-By: Timothy Gu <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Yuta Hiroto <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Reviewed-By: Refael Ackermann <[email protected]>
|
Landed in 1524458 |
MylesBorins
pushed a commit
that referenced
this pull request
Sep 10, 2017
PR-URL: #14938 Reviewed-By: Timothy Gu <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Yuta Hiroto <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Reviewed-By: Refael Ackermann <[email protected]>
Merged
MylesBorins
pushed a commit
that referenced
this pull request
Sep 12, 2017
PR-URL: #14938 Reviewed-By: Timothy Gu <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Yuta Hiroto <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Reviewed-By: Refael Ackermann <[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.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passesAffected core subsystem(s)
doc