Skip to content

Commit e318c8a

Browse files
committedJun 13, 2017
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 <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent 80c9ef0 commit e318c8a

File tree

7 files changed

+164
-160
lines changed

7 files changed

+164
-160
lines changed
 

‎doc/api/crypto.md

+146-146
Large diffs are not rendered by default.

‎doc/api/deprecations.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -616,7 +616,7 @@ The DebugContext will be removed in V8 soon and will not be available in Node
616616
[`crypto.createCredentials()`]: crypto.html#crypto_crypto_createcredentials_details
617617
[`crypto.pbkdf2()`]: crypto.html#crypto_crypto_pbkdf2_password_salt_iterations_keylen_digest_callback
618618
[`domain`]: domain.html
619-
[`ecdh.setPublicKey()`]: crypto.html#crypto_ecdh_setpublickey_public_key_encoding
619+
[`ecdh.setPublicKey()`]: crypto.html#crypto_ecdh_setpublickey_publickey_encoding
620620
[`emitter.listenerCount(eventName)`]: events.html#events_emitter_listenercount_eventname
621621
[`fs.access()`]: fs.html#fs_fs_access_path_mode_callback
622622
[`fs.exists(path, callback)`]: fs.html#fs_fs_exists_path_callback

‎doc/api/http.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -496,7 +496,7 @@ added: v0.11.14
496496
If a request has been aborted, this value is the time when the request was
497497
aborted, in milliseconds since 1 January 1970 00:00:00 UTC.
498498

499-
### request.end([data][, encoding][, callback])
499+
### request.end([data[, encoding]][, callback])
500500
<!-- YAML
501501
added: v0.1.90
502502
-->

‎doc/api/path.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -369,11 +369,11 @@ see [`path.sep`][].
369369

370370
The returned object will have the following properties:
371371

372-
* `root` {string}
373372
* `dir` {string}
373+
* `root` {string}
374374
* `base` {string}
375-
* `ext` {string}
376375
* `name` {string}
376+
* `ext` {string}
377377

378378
For example on POSIX:
379379

‎doc/api/tls.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -391,8 +391,11 @@ when the server has no more open connections.
391391
### server.connections
392392
<!-- YAML
393393
added: v0.3.2
394+
deprecated: v0.9.7
394395
-->
395396

397+
> Stability: 0 - Deprecated: Use [`server.getConnections()`][] instead.
398+
396399
Returns the current number of concurrent connections on the server.
397400

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

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

588-
### tlsSocket.getPeerCertificate([ detailed ])
591+
### tlsSocket.getPeerCertificate([detailed])
589592
<!-- YAML
590593
added: v0.11.4
591594
-->
@@ -1272,6 +1275,7 @@ where `secure_socket` has the same API as `pair.cleartext`.
12721275
[`net.Server.address()`]: net.html#net_server_address
12731276
[`net.Server`]: net.html#net_class_net_server
12741277
[`net.Socket`]: net.html#net_class_net_socket
1278+
[`server.getConnections()`]: net.html#net_server_getconnections_callback
12751279
[`tls.DEFAULT_ECDH_CURVE`]: #tls_tls_default_ecdh_curve
12761280
[`tls.TLSSocket.getPeerCertificate()`]: #tls_tlssocket_getpeercertificate_detailed
12771281
[`tls.TLSSocket`]: #tls_class_tls_tlssocket

‎doc/api/vm.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ console.log(util.inspect(sandbox));
129129
event loops and corresponding threads being started, which have a non-zero
130130
performance overhead.
131131

132-
### script.runInNewContext([sandbox][, options])
132+
### script.runInNewContext([sandbox[, options]])
133133
<!-- YAML
134134
added: v0.3.1
135135
-->
@@ -473,7 +473,7 @@ According to the [V8 Embedder's Guide][]:
473473
When the method `vm.createContext()` is called, the `sandbox` object that is
474474
passed in (or a newly created object if `sandbox` is `undefined`) is associated
475475
internally with a new instance of a V8 Context. This V8 Context provides the
476-
`code` run using the `vm` modules methods with an isolated global environment
476+
`code` run using the `vm` module's methods with an isolated global environment
477477
within which it can operate. The process of creating the V8 Context and
478478
associating it with the `sandbox` object is what this document refers to as
479479
"contextifying" the `sandbox`.

‎doc/api/zlib.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -440,14 +440,14 @@ Provides an object enumerating Zlib-related constants.
440440
added: v0.5.8
441441
-->
442442

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

445445
## zlib.createDeflateRaw([options])
446446
<!-- YAML
447447
added: v0.5.8
448448
-->
449449

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

452452
*Note*: The zlib library rejects requests for 256-byte windows (i.e.,
453453
`{ 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.
458458
added: v0.5.8
459459
-->
460460

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

463463
## zlib.createGzip([options])
464464
<!-- YAML
465465
added: v0.5.8
466466
-->
467467

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

470470
## zlib.createInflate([options])
471471
<!-- YAML
472472
added: v0.5.8
473473
-->
474474

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

477477
## zlib.createInflateRaw([options])
478478
<!-- YAML
479479
added: v0.5.8
480480
-->
481481

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

484484
## zlib.createUnzip([options])
485485
<!-- YAML
486486
added: v0.5.8
487487
-->
488488

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

491491
## Convenience Methods
492492

0 commit comments

Comments
 (0)
Please sign in to comment.