Skip to content

doc: fix various nits #19743

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

Closed
vsemozhetbyt wants to merge 7 commits into from
Closed

doc: fix various nits #19743

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
96909d1
doc: replace 2 hyphens by spaced m-dashes
vsemozhetbyt Apr 2, 2018
b03cf65
doc: space infix operators
vsemozhetbyt Apr 2, 2018
d9b6708
doc: unify quotes in inline code spans
vsemozhetbyt Apr 2, 2018
19bc89e
doc: unify `* Returns:`
vsemozhetbyt Apr 2, 2018
ba3f984
doc: dedupe spaces
vsemozhetbyt Apr 2, 2018
729ded2
fixup: some more spacing for infix operators
vsemozhetbyt Apr 2, 2018
35ec3f9
fixup: some more single quotes
vsemozhetbyt Apr 2, 2018
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
Prev Previous commit
Next Next commit
doc: unify * Returns:
  • Loading branch information
@vsemozhetbyt
vsemozhetbyt committed Apr 4, 2018
commit 19bc89ec8142013b2a336af2a3742c0e3bca4e01
4 changes: 2 additions & 2 deletions doc/api/dgram.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,14 +231,14 @@ drop membership on all valid interfaces.
added: v8.7.0
-->

* Returns {number} the `SO_RCVBUF` socket receive buffer size in bytes.
* Returns: {number} the `SO_RCVBUF` socket receive buffer size in bytes.

### socket.getSendBufferSize()
<!-- YAML
added: v8.7.0
-->

* Returns {number} the `SO_SNDBUF` socket send buffer size in bytes.
* Returns: {number} the `SO_SNDBUF` socket send buffer size in bytes.

### socket.ref()
<!-- YAML
Expand Down
2 changes: 1 addition & 1 deletion doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4060,7 +4060,7 @@ added: REPLACEME
* `path` {string|Buffer|URL}
* `flags` {string|number}
* `mode` {integer} **Default:** `0o666` (readable and writable)
* Return: {Promise}
* Returns: {Promise}

Asynchronous file open that returns a `Promise` that, when resolved, yields a
`FileHandle` object. See open(2).
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 @@ -1823,7 +1823,7 @@ changes:
* ...: Any [`tls.createServer()`][] options can be provided. For
servers, the identity options (`pfx` or `key`/`cert`) are usually required.
* `onRequestHandler` {Function} See [Compatibility API][]
* Returns {Http2SecureServer}
* Returns: {Http2SecureServer}

Returns a `tls.Server` instance that creates and manages `Http2Session`
instances.
Expand Down Expand Up @@ -1921,7 +1921,7 @@ changes:
[`Duplex`][] stream that is to be used as the connection for this session.
* ...: Any [`net.connect()`][] or [`tls.connect()`][] options can be provided.
* `listener` {Function}
* Returns {ClientHttp2Session}
* Returns: {ClientHttp2Session}

Returns a `ClientHttp2Session` instance.

Expand Down