Commit 31e39fb
doc: remove non-standard use of hyphens
Identifies the non-idiomatic usages of the '-' character
and either removes them or replaces them with colons.
Fixes: #5672
R-URL: #5677
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com>1 parent f225459 commit 31e39fb
1 file changed
Lines changed: 13 additions & 13 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -56,10 +56,10 @@ openssl pkcs12 -export -in agent5-cert.pem -inkey agent5-key.pem \ | |||
| 56 | 56 | ||
| 57 | 57 | ALPN (Application-Layer Protocol Negotiation Extension), NPN (Next | |
| 58 | 58 | Protocol Negotiation) and SNI (Server Name Indication) are TLS | |
| 59 | - handshake extensions allowing you: | ||
| 59 | + handshake extensions: | ||
| 60 | 60 | ||
| 61 | - * ALPN/NPN - to use one TLS server for multiple protocols (HTTP, SPDY, HTTP/2) | ||
| 62 | - * SNI - to use one TLS server for multiple hostnames with different SSL | ||
| 61 | + * ALPN/NPN - Allows the use of one TLS server for multiple protocols (HTTP, SPDY, HTTP/2) | ||
| 62 | + * SNI - Allows the use of one TLS server for multiple hostnames with different SSL | ||
| 63 | 63 | certificates. | |
| 64 | 64 | ||
| 65 | 65 | ## Client-initiated renegotiation attack mitigation | |
@@ -187,8 +187,8 @@ connections using TLS or SSL. | |||
| 187 | 187 | ||
| 188 | 188 | `function (exception, tlsSocket) { }` | |
| 189 | 189 | ||
| 190 | - When a client connection emits an `'error'` event before secure connection is | ||
| 191 | - established - it will be forwarded here. | ||
| 190 | + When a client connection emits an `'error'` event before a secure connection is | ||
| 191 | + established it will be forwarded here. | ||
| 192 | 192 | ||
| 193 | 193 | `tlsSocket` is the [`tls.TLSSocket`][] that the error originated from. | |
| 194 | 194 | ||
@@ -370,7 +370,7 @@ Construct a new TLSSocket object from existing TCP socket. | |||
| 370 | 370 | - `secureContext`: An optional TLS context object from | |
| 371 | 371 | [`tls.createSecureContext()`][] | |
| 372 | 372 | ||
| 373 | - - `isServer`: If `true` - TLS socket will be instantiated in server-mode. | ||
| 373 | + - `isServer`: If `true` the TLS socket will be instantiated in server-mode. | ||
| 374 | 374 | Default: `false` | |
| 375 | 375 | ||
| 376 | 376 | - `server`: An optional [`net.Server`][] instance | |
@@ -387,9 +387,9 @@ Construct a new TLSSocket object from existing TCP socket. | |||
| 387 | 387 | ||
| 388 | 388 | - `session`: Optional, a `Buffer` instance, containing TLS session | |
| 389 | 389 | ||
| 390 | - - `requestOCSP`: Optional, if `true` - OCSP status request extension would | ||
| 391 | - be added to client hello, and `'OCSPResponse'` event will be emitted on socket | ||
| 392 | - before establishing secure communication | ||
| 390 | + - `requestOCSP`: Optional, if `true` the OCSP status request extension will | ||
| 391 | + be added to the client hello, and an `'OCSPResponse'` event will be emitted | ||
| 392 | + on the socket before establishing a secure communication | ||
| 393 | 393 | ||
| 394 | 394 | ### Event: 'OCSPResponse' | |
| 395 | 395 | ||
@@ -408,7 +408,7 @@ The listener will be called no matter if the server's certificate was | |||
| 408 | 408 | authorized or not. It is up to the user to test `tlsSocket.authorized` | |
| 409 | 409 | to see if the server certificate was signed by one of the specified CAs. | |
| 410 | 410 | If `tlsSocket.authorized === false` then the error can be found in | |
| 411 | - `tlsSocket.authorizationError`. Also if ALPN or NPN was used - you can | ||
| 411 | + `tlsSocket.authorizationError`. Also, if ALPN or NPN was used you can | ||
| 412 | 412 | check `tlsSocket.alpnProtocol` or `tlsSocket.npnProtocol` for the | |
| 413 | 413 | negotiated protocol. | |
| 414 | 414 | ||
@@ -463,8 +463,8 @@ Example: | |||
| 463 | 463 | ||
| 464 | 464 | Returns an object representing the peer's certificate. The returned object has | |
| 465 | 465 | some properties corresponding to the field of the certificate. If `detailed` | |
| 466 | - argument is `true` - the full chain with `issuer` property will be returned, | ||
| 467 | - if `false` - only the top certificate without `issuer` property. | ||
| 466 | + argument is `true` the full chain with `issuer` property will be returned, | ||
| 467 | + if `false` only the top certificate without `issuer` property. | ||
| 468 | 468 | ||
| 469 | 469 | Example: | |
| 470 | 470 | ||
@@ -876,7 +876,7 @@ automatically set as a listener for the [`'secureConnection'`][] event. The | |||
| 876 | 876 | and `cb`. `SNICallback` should invoke `cb(null, ctx)`, where `ctx` is a | |
| 877 | 877 | SecureContext instance. | |
| 878 | 878 | (You can use `tls.createSecureContext(...)` to get proper | |
| 879 | - SecureContext). If `SNICallback` wasn't provided - default callback with | ||
| 879 | + SecureContext). If `SNICallback` wasn't provided the default callback with | ||
| 880 | 880 | high-level API will be used (see below). | |
| 881 | 881 | ||
| 882 | 882 | - `sessionTimeout`: An integer specifying the seconds after which TLS | |
0 commit comments