Skip to content

Commit c6dc561

Browse files
svozzaMyles Borins
authored and
Myles Borins
committed
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 <[email protected]> Reviewed-By: Claudio Rodriguez <[email protected]>
1 parent 4c92316 commit c6dc561

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

doc/api/tls.markdown

+10-10
Original file line numberDiff line numberDiff line change
@@ -193,8 +193,8 @@ connections using TLS or SSL.
193193

194194
`function (exception, tlsSocket) { }`
195195

196-
When a client connection emits an `'error'` event before secure connection is
197-
established - it will be forwarded here.
196+
When a client connection emits an `'error'` event before a secure connection is
197+
established it will be forwarded here.
198198

199199
`tlsSocket` is the [`tls.TLSSocket`][] that the error originated from.
200200

@@ -370,7 +370,7 @@ Construct a new TLSSocket object from existing TCP socket.
370370
- `secureContext`: An optional TLS context object from
371371
[`tls.createSecureContext()`][]
372372

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.
374374
Default: `false`
375375

376376
- `server`: An optional [`net.Server`][] instance
@@ -385,9 +385,9 @@ Construct a new TLSSocket object from existing TCP socket.
385385

386386
- `session`: Optional, a `Buffer` instance, containing TLS session
387387

388-
- `requestOCSP`: Optional, if `true` - OCSP status request extension would
389-
be added to client hello, and `'OCSPResponse'` event will be emitted on socket
390-
before establishing secure communication
388+
- `requestOCSP`: Optional, if `true` the OCSP status request extension will
389+
be added to the client hello, and an `'OCSPResponse'` event will be emitted
390+
on the socket before establishing a secure communication
391391

392392
### Event: 'OCSPResponse'
393393

@@ -406,7 +406,7 @@ The listener will be called no matter if the server's certificate was
406406
authorized or not. It is up to the user to test `tlsSocket.authorized`
407407
to see if the server certificate was signed by one of the specified CAs.
408408
If `tlsSocket.authorized === false` then the error can be found in
409-
`tlsSocket.authorizationError`. Also if NPN was used - you can check
409+
`tlsSocket.authorizationError`. Also if NPN was used you can check
410410
`tlsSocket.npnProtocol` for negotiated protocol.
411411

412412
### tlsSocket.address()
@@ -446,8 +446,8 @@ information.
446446

447447
Returns an object representing the peer's certificate. The returned object has
448448
some properties corresponding to the field of the certificate. If `detailed`
449-
argument is `true` - the full chain with `issuer` property will be returned,
450-
if `false` - only the top certificate without `issuer` property.
449+
argument is `true` the full chain with `issuer` property will be returned,
450+
if `false` only the top certificate without `issuer` property.
451451

452452
Example:
453453

@@ -817,7 +817,7 @@ automatically set as a listener for the [`'secureConnection'`][] event. The
817817
and `cb`. `SNICallback` should invoke `cb(null, ctx)`, where `ctx` is a
818818
SecureContext instance.
819819
(You can use `tls.createSecureContext(...)` to get proper
820-
SecureContext). If `SNICallback` wasn't provided - default callback with
820+
SecureContext). If `SNICallback` wasn't provided the default callback with
821821
high-level API will be used (see below).
822822

823823
- `sessionTimeout`: An integer specifying the seconds after which TLS

0 commit comments

Comments
 (0)