Skip to content

doc: simplify and correct example descriptions in net.md #32451

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.

Sign up for GitHub

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

Merged
Trott merged 1 commit into from
Mar 26, 2020
Merged

doc: simplify and correct example descriptions in net.md #32451

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
doc: simplify and correct example descriptions in net.md 
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>
  • Loading branch information
@Trott
Trott committed Mar 26, 2020
commit f0a33d99ec4656b87bebb97162837047b52eb6f8
6 changes: 2 additions & 4 deletions doc/api/net.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`:
Copy link
Copy Markdown
Member

@jasnell jasnell Mar 24, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aside: gee how I wish we could associate captions with codeblocks...


```js
const client = net.createConnection({ path: '/tmp/echo.sock' });
Expand Down Expand Up @@ -1174,8 +1173,7 @@ Test this by using `telnet`:
$ telnet localhost 8124
```

To listen on the socket `/tmp/echo.sock` the third line from the last would
just be changed to:
To listen on the socket `/tmp/echo.sock`:

```js
server.listen('/tmp/echo.sock', () => {
Expand Down