Skip to content

Commit 10f9374

Browse files
rubystargos
rubys
authored and
targos
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 7352b72 commit 10f9374

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
@@ -2674,18 +2674,18 @@ the `crypto`, `tls`, and `https` modules and are generally specific to OpenSSL.
26742674
</tr>
26752675
<tr>
26762676
<td><code>RSA_PSS_SALTLEN_DIGEST</code></td>
2677-
<td>Sets the salt length for `RSA_PKCS1_PSS_PADDING` to the digest size
2678-
when signing or verifying.</td>
2677+
<td>Sets the salt length for <code>RSA_PKCS1_PSS_PADDING</code> to the
2678+
digest size when signing or verifying.</td>
26792679
</tr>
26802680
<tr>
26812681
<td><code>RSA_PSS_SALTLEN_MAX_SIGN</code></td>
2682-
<td>Sets the salt length for `RSA_PKCS1_PSS_PADDING` to the maximum
2683-
permissible value when signing data.</td>
2682+
<td>Sets the salt length for <code>RSA_PKCS1_PSS_PADDING</code> to the
2683+
maximum permissible value when signing data.</td>
26842684
</tr>
26852685
<tr>
26862686
<td><code>RSA_PSS_SALTLEN_AUTO</code></td>
2687-
<td>Causes the salt length for `RSA_PKCS1_PSS_PADDING` to be determined
2688-
automatically when verifying a signature.</td>
2687+
<td>Causes the salt length for <code>RSA_PKCS1_PSS_PADDING</code> to be
2688+
determined automatically when verifying a signature.</td>
26892689
</tr>
26902690
<tr>
26912691
<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
@@ -4373,8 +4373,8 @@ The following constants are meant for use with `fs.open()`.
43734373
<tr>
43744374
<td><code>O_NOATIME</code></td>
43754375
<td>Flag indicating reading accesses to the file system will no longer
4376-
result in an update to the `atime` information associated with the file.
4377-
This flag is available on Linux operating systems only.</td>
4376+
result in an update to the <code>atime</code> information associated with
4377+
the file. This flag is available on Linux operating systems only.</td>
43784378
</tr>
43794379
<tr>
43804380
<td><code>O_NOFOLLOW</code></td>

‎doc/api/http.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1896,9 +1896,9 @@ changes:
18961896
Authorization header.
18971897
* `agent` {http.Agent | boolean} Controls [`Agent`][] behavior. Possible
18981898
values:
1899-
* `undefined` (default): use [`http.globalAgent`][] for this host and port.
1900-
* `Agent` object: explicitly use the passed in `Agent`.
1901-
* `false`: causes a new `Agent` with default values to be used.
1899+
* `undefined` (default): use [`http.globalAgent`][] for this host and port.
1900+
* `Agent` object: explicitly use the passed in `Agent`.
1901+
* `false`: causes a new `Agent` with default values to be used.
19021902
* `createConnection` {Function} A function that produces a socket/stream to
19031903
use for the request when the `agent` option is not used. This can be used to
19041904
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
@@ -1419,77 +1419,12 @@ class MyWritable extends Writable {
14191419
The new stream class must then implement one or more specific methods, depending
14201420
on the type of stream being created, as detailed in the chart below:
14211421

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

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

0 commit comments

Comments
 (0)