Skip to content

Commit

Permalink
doc: unify optional arguments format in headings
Browse files Browse the repository at this point in the history
Make space and comma distribution in some headings
consistent with the majority of headings.

PR-URL: #22397
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
  • Loading branch information
vsemozhetbyt authored and targos committed Sep 3, 2018
1 parent 1828017 commit 1ebaa2a
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion doc/api/dgram.md
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ Calling `socket.ref()` multiples times will have no additional effect.
The `socket.ref()` method returns a reference to the socket so calls can be
chained.

### socket.send(msg, [offset, length,] port [, address] [, callback])
### socket.send(msg[, offset, length], port[, address][, callback])
<!-- YAML
added: v0.1.99
changes:
Expand Down
4 changes: 2 additions & 2 deletions doc/api/http2.md
Original file line number Diff line number Diff line change
Expand Up @@ -349,7 +349,7 @@ Will be `true` if this `Http2Session` instance is still connecting, will be set
to `false` before emitting `connect` event and/or calling the `http2.connect`
callback.

#### http2session.destroy([error,][code])
#### http2session.destroy([error][, code])
<!-- YAML
added: v8.4.0
-->
Expand Down Expand Up @@ -392,7 +392,7 @@ connected, `true` if the `Http2Session` is connected with a `TLSSocket`,
and `false` if the `Http2Session` is connected to any other kind of socket
or stream.

#### http2session.goaway([code, [lastStreamID, [opaqueData]]])
#### http2session.goaway([code[, lastStreamID[, opaqueData]]])
<!-- YAML
added: v9.4.0
-->
Expand Down
2 changes: 1 addition & 1 deletion doc/api/repl.md
Original file line number Diff line number Diff line change
Expand Up @@ -433,7 +433,7 @@ buffered but not yet executed. This method is primarily intended to be
called from within the action function for commands registered using the
`replServer.defineCommand()` method.

### replServer.parseREPLKeyword(keyword, [rest])
### replServer.parseREPLKeyword(keyword[, rest])
<!-- YAML
added: v0.8.9
deprecated: v9.0.0
Expand Down
2 changes: 1 addition & 1 deletion doc/api/zlib.md
Original file line number Diff line number Diff line change
Expand Up @@ -435,7 +435,7 @@ added: v0.9.4

Close the underlying handle.

### zlib.flush([kind], callback)
### zlib.flush([kind, ]callback)
<!-- YAML
added: v0.5.8
-->
Expand Down

0 comments on commit 1ebaa2a

Please sign in to comment.