Skip to content

Commit 85d7d97

Browse files
committed
doc: delint
PR-URL: #14707 Refs: #12756 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Daijiro Wachi <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]>
1 parent 6d84e30 commit 85d7d97

File tree

2 files changed

+13
-11
lines changed

2 files changed

+13
-11
lines changed

doc/api/http2.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -1850,8 +1850,8 @@ const server = http2.createServer((req, res) => {
18501850
});
18511851
```
18521852

1853-
In order to create a mixed [HTTPS](https) and HTTP/2 server, refer to the
1854-
[ALPN negotiation](alpn-negotiation) section.
1853+
In order to create a mixed [HTTPS][] and HTTP/2 server, refer to the
1854+
[ALPN negotiation][] section.
18551855
Upgrading from non-tls HTTP/1 servers is not supported.
18561856

18571857
The HTTP2 compatibility API is composed of [`Http2ServerRequest`]() and
@@ -1861,10 +1861,10 @@ the status message for HTTP codes is ignored.
18611861

18621862
### ALPN negotiation
18631863

1864-
ALPN negotiation allows to support both [HTTPS](https) and HTTP/2 over
1864+
ALPN negotiation allows to support both [HTTPS][] and HTTP/2 over
18651865
the same socket. The `req` and `res` objects can be either HTTP/1 or
18661866
HTTP/2, and an application **must** restrict itself to the public API of
1867-
[HTTP/1](), and detect if it is possible to use the more advanced
1867+
[HTTP/1][], and detect if it is possible to use the more advanced
18681868
features of HTTP/2.
18691869

18701870
The following example creates a server that supports both protocols:
@@ -1925,7 +1925,7 @@ abnormally aborted in mid-communication.
19251925
added: REPLACEME
19261926
-->
19271927

1928-
Indicates that the underlying [`Http2Stream`]() was closed.
1928+
Indicates that the underlying [`Http2Stream`][] was closed.
19291929
Just like `'end'`, this event occurs only once per response.
19301930

19311931
#### request.destroy([error])
@@ -1935,7 +1935,7 @@ added: REPLACEME
19351935

19361936
* `error` {Error}
19371937

1938-
Calls `destroy()` on the [Http2Stream]() that received the `ServerRequest`. If
1938+
Calls `destroy()` on the [`Http2Stream`][] that received the [`ServerRequest`][]. If
19391939
`error` is provided, an `'error'` event is emitted and `error` is passed as an
19401940
argument to any listeners on the event.
19411941

@@ -2570,21 +2570,21 @@ will result in a [`TypeError`][] being thrown.
25702570
added: REPLACEME
25712571
-->
25722572

2573-
Call [`stream.pushStream()`]() with the given headers, and wraps the
2573+
Call [`stream.pushStream()`][] with the given headers, and wraps the
25742574
given newly created [`Http2Stream`] on `Http2ServerRespose`.
25752575

25762576
The callback will be called with an error with code `ERR_HTTP2_STREAM_CLOSED`
25772577
if the stream is closed.
25782578

25792579
[HTTP/2]: https://tools.ietf.org/html/rfc7540
25802580
[HTTP/1]: http.html
2581-
[https]: https.html
2581+
[HTTPS]: https.html
25822582
[`net.Socket`]: net.html
25832583
[`tls.TLSSocket`]: tls.html
25842584
[`tls.createServer()`]: tls.html#tls_tls_createserver_options_secureconnectionlistener
25852585
[`ClientHttp2Stream`]: #http2_class_clienthttp2stream
25862586
[Compatibility API]: #http2_compatibility_api
2587-
[alpn-negotiation]: #http2_alpn_negotiation
2587+
[ALPN negotiation]: #http2_alpn_negotiation
25882588
[`Duplex`]: stream.html#stream_class_stream_duplex
25892589
[Headers Object]: #http2_headers_object
25902590
[`Http2Stream`]: #http2_class_http2stream

doc/api/n-api.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -342,15 +342,15 @@ to be added to the error object. If the optional parameter is NULL
342342
then no code will be associated with the error. If a code is provided,
343343
the name associated with the error is also updated to be:
344344
345-
```
345+
```text
346346
originalName [code]
347347
```
348348

349349
where originalName is the original name associated with the error
350350
and code is the code that was provided. For example if the code
351351
is 'ERR_ERROR_1' and a TypeError is being created the name will be:
352352

353-
```
353+
```text
354354
TypeError [ERR_ERROR_1]
355355
```
356356

@@ -3342,6 +3342,8 @@ support it:
33423342
* If the function is not available, provide an alternate implementation
33433343
that does not use the function.
33443344

3345+
<!-- it's very convenient to have all the anchors indexed -->
3346+
<!--lint disable no-unused-definitions remark-lint-->
33453347
[Asynchronous Operations]: #n_api_asynchronous_operations
33463348
[Basic N-API Data Types]: #n_api_basic_n_api_data_types
33473349
[ECMAScript Language Specification]: https://tc39.github.io/ecma262/

0 commit comments

Comments
 (0)