1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: simplify and correct example descriptions in net.md

Browse Source 
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: https://github.com/nodejs/node/pull/32451
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
This commit is contained in:
Rich Trott 2020-03-23 23:04:38 -07:00
parent dade90db9c
commit f0a33d99ec
1 changed files with 2 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/api/net.md
View File

@ -1064,8 +1064,7 @@ client.on('end', () => {
}); });
``` ```
To connect on the socket `/tmp/echo.sock` the second line would just be To connect on the socket `/tmp/echo.sock`:
changed to:
```js ```js
const client = net.createConnection({ path: '/tmp/echo.sock' }); const client = net.createConnection({ path: '/tmp/echo.sock' });
@ -1174,8 +1173,7 @@ Test this by using `telnet`:
$ telnet localhost 8124 $ telnet localhost 8124
``` ```
To listen on the socket `/tmp/echo.sock` the third line from the last would To listen on the socket `/tmp/echo.sock`:
just be changed to:
```js ```js
server.listen('/tmp/echo.sock', () => { server.listen('/tmp/echo.sock', () => {