doc: fix minor issues reported in #9538

oath.md: make order of properties consistent tls.md: remove spaces in getPeerCertificate signature tls.md: add deprecation notice to server.connections http.md: fix signature of request.end crypto.md: change crypto parameters to camelCase vm.md: add missing apostrophe vm.md: fix signature of vm.runInNewContext zlib.md: improve description of zlib.createXYZ PR-URL: #13491 Ref: #9538 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
nodejs · Jun 17, 2017 · 7af65a1 · 7af65a1
1 parent 5d1bb99
commit 7af65a1
Show file tree

Hide file tree

Showing 7 changed files with 164 additions and 160 deletions.
diff --git a/doc/api/crypto.md b/doc/api/crypto.md
diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md
@@ -646,7 +646,7 @@ Type: Runtime
 [`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

diff --git a/doc/api/http.md b/doc/api/http.md
@@ -496,7 +496,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
 -->

diff --git a/doc/api/path.md b/doc/api/path.md
@@ -369,11 +369,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:
 

diff --git a/doc/api/tls.md b/doc/api/tls.md
@@ -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()
@@ -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
 -->
@@ -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

diff --git a/doc/api/vm.md b/doc/api/vm.md
@@ -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
 -->
@@ -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`.

diff --git a/doc/api/zlib.md b/doc/api/zlib.md
@@ -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
@@ -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