doc: simplify and correct example descriptions in net.md #32451
Merged
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
addaleax
approved these changes
Mar 24, 2020
Trott
added
the
author ready
trivikr
approved these changes
Mar 24, 2020
jasnell
reviewed
Mar 24, 2020
| @@ -1064,8 +1064,7 @@ client.on('end', () => { | |||
| }); | |||
| ``` | |||
|
|
|||
| To connect on the socket `/tmp/echo.sock` the second line would just be | |||
| changed to: | |||
| To connect on the socket `/tmp/echo.sock`: | |||
There was a problem hiding this comment.
Aside: gee how I wish we could associate captions with codeblocks...
jasnell
approved these changes
Mar 24, 2020
Instead of indicating that examples show lines to change in previous examples, present the examples as standalone items. They suffice on their own. In the first of these, it says to change "the second line" of a previous example, but if it were literally changed to the provided line, it would result in a syntax error. In the second of these, it gives the wrong line to change. All of this is unnecessary and probably makes the examples harder to follow. So simplify and treat each one as a separate example. PR-URL: nodejs#32451 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
|
Landed in f0a33d9 |
MylesBorins
pushed a commit
that referenced
this pull request
Mar 26, 2020
Instead of indicating that examples show lines to change in previous examples, present the examples as standalone items. They suffice on their own. In the first of these, it says to change "the second line" of a previous example, but if it were literally changed to the provided line, it would result in a syntax error. In the second of these, it gives the wrong line to change. All of this is unnecessary and probably makes the examples harder to follow. So simplify and treat each one as a separate example. PR-URL: #32451 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Merged
targos
pushed a commit
that referenced
this pull request
Apr 22, 2020
Instead of indicating that examples show lines to change in previous examples, present the examples as standalone items. They suffice on their own. In the first of these, it says to change "the second line" of a previous example, but if it were literally changed to the provided line, it would result in a syntax error. In the second of these, it gives the wrong line to change. All of this is unnecessary and probably makes the examples harder to follow. So simplify and treat each one as a separate example. PR-URL: #32451 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
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.
Instead of indicating that examples show lines to change in previous
examples, present the examples as standalone items. They suffice on
their own.
In the first of these, it says to change "the second line" of a previous
example, but if it were literally changed to the provided line, it would
result in a syntax error.
In the second of these, it gives the wrong line to change.
All of this is unnecessary and probably makes the examples harder to
follow. So simplify and treat each one as a separate example.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes