Skip to content

Commit 9558c1c

Browse files
committed
doc: fix linter issues
PR-URL: #60636 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
1 parent cdf70de commit 9558c1c

File tree

3 files changed

+11
-13
lines changed

3 files changed

+11
-13
lines changed

doc/api/http.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -251,19 +251,19 @@ added: v0.11.4
251251

252252
Produces a socket/stream to be used for HTTP requests.
253253

254-
By default, this function behaves identically to [`net.createConnection(options)`][],
254+
By default, this function behaves identically to [`net.createConnection()`][],
255255
synchronously returning the created socket. The optional `callback` parameter in the
256256
signature is **not** used by this default implementation.
257257

258258
However, custom agents may override this method to provide greater flexibility,
259259
for example, to create sockets asynchronously. When overriding `createConnection`:
260260

261-
1. **Synchronous socket creation**: The overriding method can return the
262-
socket/stream directly.
263-
2. **Asynchronous socket creation**: The overriding method can accept the `callback`
264-
and pass the created socket/stream to it (e.g., `callback(null, newSocket)`).
265-
If an error occurs during socket creation, it should be passed as the first
266-
argument to the `callback` (e.g., `callback(err)`).
261+
1. **Synchronous socket creation**: The overriding method can return the
262+
socket/stream directly.
263+
2. **Asynchronous socket creation**: The overriding method can accept the `callback`
264+
and pass the created socket/stream to it (e.g., `callback(null, newSocket)`).
265+
If an error occurs during socket creation, it should be passed as the first
266+
argument to the `callback` (e.g., `callback(err)`).
267267

268268
The agent will call the provided `createConnection` function with `options` and
269269
this internal `callback`. The `callback` provided by the agent has a signature

doc/api/https.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ An [`Agent`][] object for HTTPS similar to [`http.Agent`][]. See
6464
Like `http.Agent`, the `createConnection(options[, callback])` method can be overridden
6565
to customize how TLS connections are established.
6666

67-
> See [`http.Agent#createConnection()`][] for details on overriding this method,
67+
> See [`agent.createConnection()`][] for details on overriding this method,
6868
> including asynchronous socket creation with a callback.
6969
7070
### `new Agent([options])`
@@ -742,6 +742,7 @@ statusCode: 200
742742
[`Agent`]: #class-httpsagent
743743
[`Session Resumption`]: tls.md#session-resumption
744744
[`URL`]: url.md#the-whatwg-url-api
745+
[`agent.createConnection()`]: http.md#agentcreateconnectionoptions-callback
745746
[`http.Agent(options)`]: http.md#new-agentoptions
746747
[`http.Agent`]: http.md#class-httpagent
747748
[`http.ClientRequest`]: http.md#class-httpclientrequest

glossary.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,14 @@ This file documents various terms and definitions used throughout the Node.js co
44

55
* **ABI**: [Application Binary Interface][] - Defines the interface between two binary program modules.
66
* **AFAICT**: As Far As I Can Tell.
7-
* **AFAICT**: As Far As I Can Tell.
8-
* **AFAIK**: As Far As I Know.
97
* **AFAIK**: As Far As I Know.
108
* **API**: [Application Programming Interface][] - A set of rules and protocols that allows different software
119
applications to communicate with each other. APIs are used to enable integration between different systems.
1210
* **ASAP**: As Soon As Possible.
13-
* **ASLR**: Address Space Layout Randomization. A security technique that randomizes memory addresses to prevent certain attacks.
11+
* **ASLR**: Address Space Layout Randomization. A security technique that randomizes memory addresses
12+
to prevent certain attacks.
1413
* **Backport**: The process of applying a fix or feature from a newer branch to an older supported
1514
branch (e.g., applying a security fix to an LTS release).
16-
* **BE** ([Big Endian]): Byte order in which the most significant byte is stored first in memory.
17-
Opposite of **LE** (Little Endian).
1815
* **BE**: Big [Endian][] - A Byte Order where the largest bit comes first. The opposite of **LE**.
1916
* **Bootstrap**: Early phase in the Node.js process startup - sets up the execution environment and loads internal
2017
modules.

0 commit comments

Comments
 (0)