Skip to content

Commit 6a99e3e

Browse files
rubysvsemozhetbyt
rubys
authored and
vsemozhetbyt
committed
doc: make markdown input compliant
PR-URL: #21780 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Сковорода Никита Андреевич <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
1 parent 40c85ff commit 6a99e3e

File tree

5 files changed

+25
-89
lines changed

5 files changed

+25
-89
lines changed

‎doc/api/crypto.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2652,18 +2652,18 @@ the `crypto`, `tls`, and `https` modules and are generally specific to OpenSSL.
26522652
</tr>
26532653
<tr>
26542654
<td><code>RSA_PSS_SALTLEN_DIGEST</code></td>
2655-
<td>Sets the salt length for `RSA_PKCS1_PSS_PADDING` to the digest size
2656-
when signing or verifying.</td>
2655+
<td>Sets the salt length for <code>RSA_PKCS1_PSS_PADDING</code> to the
2656+
digest size when signing or verifying.</td>
26572657
</tr>
26582658
<tr>
26592659
<td><code>RSA_PSS_SALTLEN_MAX_SIGN</code></td>
2660-
<td>Sets the salt length for `RSA_PKCS1_PSS_PADDING` to the maximum
2661-
permissible value when signing data.</td>
2660+
<td>Sets the salt length for <code>RSA_PKCS1_PSS_PADDING</code> to the
2661+
maximum permissible value when signing data.</td>
26622662
</tr>
26632663
<tr>
26642664
<td><code>RSA_PSS_SALTLEN_AUTO</code></td>
2665-
<td>Causes the salt length for `RSA_PKCS1_PSS_PADDING` to be determined
2666-
automatically when verifying a signature.</td>
2665+
<td>Causes the salt length for <code>RSA_PKCS1_PSS_PADDING</code> to be
2666+
determined automatically when verifying a signature.</td>
26672667
</tr>
26682668
<tr>
26692669
<td><code>POINT_CONVERSION_COMPRESSED</code></td>

‎doc/api/fs.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4378,8 +4378,8 @@ The following constants are meant for use with `fs.open()`.
43784378
<tr>
43794379
<td><code>O_NOATIME</code></td>
43804380
<td>Flag indicating reading accesses to the file system will no longer
4381-
result in an update to the `atime` information associated with the file.
4382-
This flag is available on Linux operating systems only.</td>
4381+
result in an update to the <code>atime</code> information associated with
4382+
the file. This flag is available on Linux operating systems only.</td>
43834383
</tr>
43844384
<tr>
43854385
<td><code>O_NOFOLLOW</code></td>

‎doc/api/http.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1912,9 +1912,9 @@ changes:
19121912
Authorization header.
19131913
* `agent` {http.Agent | boolean} Controls [`Agent`][] behavior. Possible
19141914
values:
1915-
* `undefined` (default): use [`http.globalAgent`][] for this host and port.
1916-
* `Agent` object: explicitly use the passed in `Agent`.
1917-
* `false`: causes a new `Agent` with default values to be used.
1915+
* `undefined` (default): use [`http.globalAgent`][] for this host and port.
1916+
* `Agent` object: explicitly use the passed in `Agent`.
1917+
* `false`: causes a new `Agent` with default values to be used.
19181918
* `createConnection` {Function} A function that produces a socket/stream to
19191919
use for the request when the `agent` option is not used. This can be used to
19201920
avoid creating a custom `Agent` class just to override the default

‎doc/api/os.md‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -442,7 +442,7 @@ The following signal constants are exported by `os.constants.signals`:
442442
<tr>
443443
<td><code>SIGINT</code></td>
444444
<td>Sent to indicate when a user wishes to interrupt a process
445-
(`(Ctrl+C)`).</td>
445+
(<code>(Ctrl+C)</code>).</td>
446446
</tr>
447447
<tr>
448448
<td><code>SIGQUIT</code></td>
@@ -855,9 +855,9 @@ The following error constants are exported by `os.constants.errno`:
855855
</tr>
856856
<tr>
857857
<td><code>EOPNOTSUPP</code></td>
858-
<td>Indicates that an operation is not supported on the socket.
859-
Note that while `ENOTSUP` and `EOPNOTSUPP` have the same value on Linux,
860-
according to POSIX.1 these error values should be distinct.)</td>
858+
<td>Indicates that an operation is not supported on the socket. Note that
859+
while <code>ENOTSUP</code> and <code>EOPNOTSUPP</code> have the same value
860+
on Linux, according to POSIX.1 these error values should be distinct.)</td>
861861
</tr>
862862
<tr>
863863
<td><code>EOVERFLOW</code></td>
@@ -1114,7 +1114,8 @@ The following error codes are specific to the Windows operating system:
11141114
</tr>
11151115
<tr>
11161116
<td><code>WSAVERNOTSUPPORTED</code></td>
1117-
<td>Indicates that the `winsock.dll` version is out of range.</td>
1117+
<td>Indicates that the <code>winsock.dll</code> version is out of
1118+
range.</td>
11181119
</tr>
11191120
<tr>
11201121
<td><code>WSANOTINITIALISED</code></td>
@@ -1197,8 +1198,8 @@ information.
11971198
</tr>
11981199
<tr>
11991200
<td><code>RTLD_LOCAL</code></td>
1200-
<td>The converse of `RTLD_GLOBAL`. This is the default behavior if neither
1201-
flag is specified.</td>
1201+
<td>The converse of <code>RTLD_GLOBAL</code>. This is the default behavior
1202+
if neither flag is specified.</td>
12021203
</tr>
12031204
<tr>
12041205
<td><code>RTLD_DEEPBIND</code></td>

‎doc/api/stream.md‎

Lines changed: 6 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -1421,77 +1421,12 @@ class MyWritable extends Writable {
14211421
The new stream class must then implement one or more specific methods, depending
14221422
on the type of stream being created, as detailed in the chart below:
14231423

1424-
<table>
1425-
<thead>
1426-
<tr>
1427-
<th>
1428-
<p>Use-case</p>
1429-
</th>
1430-
<th>
1431-
<p>Class</p>
1432-
</th>
1433-
<th>
1434-
<p>Method(s) to implement</p>
1435-
</th>
1436-
</tr>
1437-
</thead>
1438-
<tr>
1439-
<td>
1440-
<p>Reading only</p>
1441-
</td>
1442-
<td>
1443-
<p>[`Readable`](#stream_class_stream_readable)</p>
1444-
</td>
1445-
<td>
1446-
<p><code>[_read][stream-_read]</code></p>
1447-
</td>
1448-
</tr>
1449-
<tr>
1450-
<td>
1451-
<p>Writing only</p>
1452-
</td>
1453-
<td>
1454-
<p>[`Writable`](#stream_class_stream_writable)</p>
1455-
</td>
1456-
<td>
1457-
<p>
1458-
<code>[_write][stream-_write]</code>,
1459-
<code>[_writev][stream-_writev]</code>,
1460-
<code>[_final][stream-_final]</code>
1461-
</p>
1462-
</td>
1463-
</tr>
1464-
<tr>
1465-
<td>
1466-
<p>Reading and writing</p>
1467-
</td>
1468-
<td>
1469-
<p>[`Duplex`](#stream_class_stream_duplex)</p>
1470-
</td>
1471-
<td>
1472-
<p>
1473-
<code>[_read][stream-_read]</code>,
1474-
<code>[_write][stream-_write]</code>,
1475-
<code>[_writev][stream-_writev]</code>,
1476-
<code>[_final][stream-_final]</code></p>
1477-
</td>
1478-
</tr>
1479-
<tr>
1480-
<td>
1481-
<p>Operate on written data, then read the result</p>
1482-
</td>
1483-
<td>
1484-
<p>[`Transform`](#stream_class_stream_transform)</p>
1485-
</td>
1486-
<td>
1487-
<p>
1488-
<code>[_transform][stream-_transform]</code>,
1489-
<code>[_flush][stream-_flush]</code>,
1490-
<code>[_final][stream-_final]</code>
1491-
</p>
1492-
</td>
1493-
</tr>
1494-
</table>
1424+
| Use-case | Class | Method(s) to implement |
1425+
| -------- | ----- | ---------------------- |
1426+
| Reading only | [`Readable`] | <code>[_read][stream-_read]</code> |
1427+
| Writing only | [`Writable`] | <code>[_write][stream-_write]</code>, <code>[_writev][stream-_writev]</code>, <code>[_final][stream-_final]</code> |
1428+
| Reading and writing | [`Duplex`] | <code>[_read][stream-_read]</code>, <code>[_write][stream-_write]</code>, <code>[_writev][stream-_writev]</code>, <code>[_final][stream-_final]</code> |
1429+
| Operate on written data, then read the result | [`Transform`] | <code>[_transform][stream-_transform]</code>, <code>[_flush][stream-_flush]</code>, <code>[_final][stream-_final]</code> |
14951430

14961431
The implementation code for a stream should *never* call the "public" methods
14971432
of a stream that are intended for use by consumers (as described in the

0 commit comments

Comments
 (0)