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.

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

doc: minor issues #13491

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
292 changes: 146 additions & 146 deletions doc/api/crypto.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion doc/api/deprecations.md
Original file line number Diff line number Diff line change
Expand Up @@ -616,7 +616,7 @@ The DebugContext will be removed in V8 soon and will not be available in Node
[`crypto.createCredentials()`]: crypto.html#crypto_crypto_createcredentials_details
[`crypto.pbkdf2()`]: crypto.html#crypto_crypto_pbkdf2_password_salt_iterations_keylen_digest_callback
[`domain`]: domain.html
[`ecdh.setPublicKey()`]: crypto.html#crypto_ecdh_setpublickey_public_key_encoding
[`ecdh.setPublicKey()`]: crypto.html#crypto_ecdh_setpublickey_publickey_encoding
[`emitter.listenerCount(eventName)`]: events.html#events_emitter_listenercount_eventname
[`fs.access()`]: fs.html#fs_fs_access_path_mode_callback
[`fs.exists(path, callback)`]: fs.html#fs_fs_exists_path_callback
Expand Down
2 changes: 1 addition & 1 deletion doc/api/http.md
Original file line number Diff line number Diff line change
Expand Up @@ -460,7 +460,7 @@ added: v0.11.14
If a request has been aborted, this value is the time when the request was
aborted, in milliseconds since 1 January 1970 00:00:00 UTC.

### request.end([data][, encoding][, callback])
### request.end([data[, encoding]][, callback])
<!-- YAML
added: v0.1.90
-->
Expand Down
4 changes: 2 additions & 2 deletions doc/api/path.md
Original file line number Diff line number Diff line change
Expand Up @@ -363,11 +363,11 @@ see [`path.sep`][].

The returned object will have the following properties:

* `root` {string}
* `dir` {string}
* `root` {string}
* `base` {string}
* `ext` {string}
* `name` {string}
* `ext` {string}

For example on POSIX:

Expand Down
6 changes: 5 additions & 1 deletion doc/api/tls.md
Original file line number Diff line number Diff line change
Expand Up @@ -391,8 +391,11 @@ when the server has no more open connections.
### server.connections
<!-- YAML
added: v0.3.2
deprecated: v0.9.7
-->

> Stability: 0 - Deprecated: Use [`server.getConnections()`][] instead.

Returns the current number of concurrent connections on the server.

### server.getTicketKeys()
Expand Down Expand Up @@ -585,7 +588,7 @@ if called on a server socket. The supported types are `'DH'` and `'ECDH'`. The

For Example: `{ type: 'ECDH', name: 'prime256v1', size: 256 }`

### tlsSocket.getPeerCertificate([ detailed ])
### tlsSocket.getPeerCertificate([detailed])
<!-- YAML
added: v0.11.4
-->
Expand Down Expand Up @@ -1272,6 +1275,7 @@ where `secure_socket` has the same API as `pair.cleartext`.
[`net.Server.address()`]: net.html#net_server_address
[`net.Server`]: net.html#net_class_net_server
[`net.Socket`]: net.html#net_class_net_socket
[`server.getConnections()`]: net.html#net_server_getconnections_callback
[`tls.DEFAULT_ECDH_CURVE`]: #tls_tls_default_ecdh_curve
[`tls.TLSSocket.getPeerCertificate()`]: #tls_tlssocket_getpeercertificate_detailed
[`tls.TLSSocket`]: #tls_class_tls_tlssocket
Expand Down
4 changes: 2 additions & 2 deletions doc/api/vm.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ console.log(util.inspect(sandbox));
event loops and corresponding threads being started, which have a non-zero
performance overhead.

### script.runInNewContext([sandbox][, options])
### script.runInNewContext([sandbox[, options]])
<!-- YAML
added: v0.3.1
-->
Expand Down Expand Up @@ -473,7 +473,7 @@ According to the [V8 Embedder's Guide][]:
When the method `vm.createContext()` is called, the `sandbox` object that is
passed in (or a newly created object if `sandbox` is `undefined`) is associated
internally with a new instance of a V8 Context. This V8 Context provides the
`code` run using the `vm` modules methods with an isolated global environment
`code` run using the `vm` module's methods with an isolated global environment
within which it can operate. The process of creating the V8 Context and
associating it with the `sandbox` object is what this document refers to as
"contextifying" the `sandbox`.
Expand Down
14 changes: 7 additions & 7 deletions doc/api/zlib.md
Original file line number Diff line number Diff line change
Expand Up @@ -440,14 +440,14 @@ Provides an object enumerating Zlib-related constants.
added: v0.5.8
-->

Returns a new [Deflate][] object with an [options][].
Creates and returns a new [Deflate][] object with the given [options][].

## zlib.createDeflateRaw([options])
<!-- YAML
added: v0.5.8
-->

Returns a new [DeflateRaw][] object with an [options][].
Creates and returns a new [DeflateRaw][] object with the given [options][].

*Note*: The zlib library rejects requests for 256-byte windows (i.e.,
`{ windowBits: 8 }` in `options`). An `Error` will be thrown when creating
Expand All @@ -458,35 +458,35 @@ a [DeflateRaw][] object with this specific value of the `windowBits` option.
added: v0.5.8
-->

Returns a new [Gunzip][] object with an [options][].
Creates and returns a new [Gunzip][] object with the given [options][].

## zlib.createGzip([options])
<!-- YAML
added: v0.5.8
-->

Returns a new [Gzip][] object with an [options][].
Creates and returns a new [Gzip][] object with the given [options][].

## zlib.createInflate([options])
<!-- YAML
added: v0.5.8
-->

Returns a new [Inflate][] object with an [options][].
Creates and returns a new [Inflate][] object with the given [options][].

## zlib.createInflateRaw([options])
<!-- YAML
added: v0.5.8
-->

Returns a new [InflateRaw][] object with an [options][].
Creates and returns a new [InflateRaw][] object with the given [options][].

## zlib.createUnzip([options])
<!-- YAML
added: v0.5.8
-->

Returns a new [Unzip][] object with an [options][].
Creates and returns a new [Unzip][] object with the given [options][].

## Convenience Methods

Expand Down