Skip to content
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

Jump to bottom

doc: unify optional arguments format in headings #22397

Closed
wants to merge 1 commit into from
Closed

doc: unify optional arguments format in headings #22397

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion doc/api/dgram.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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