diff options
author | Sam Ruby <rubys@intertwingly.net> | 2018-07-12 13:28:42 -0400 |
---|---|---|
committer | Vse Mozhet Byt <vsemozhetbyt@gmail.com> | 2018-07-16 00:04:56 +0300 |
commit | 6a99e3e21c5ce13eb079c5d29db4d4fe616802fc (patch) | |
tree | 5469aec26896e835c66f867c150dd87e52cfdf4a /doc | |
parent | 40c85ff0634913f4c61e13cbb7cacb7e2c76120f (diff) | |
download | android-node-v8-6a99e3e21c5ce13eb079c5d29db4d4fe616802fc.tar.gz android-node-v8-6a99e3e21c5ce13eb079c5d29db4d4fe616802fc.tar.bz2 android-node-v8-6a99e3e21c5ce13eb079c5d29db4d4fe616802fc.zip |
doc: make markdown input compliant
PR-URL: https://github.com/nodejs/node/pull/21780
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/crypto.md | 12 | ||||
-rw-r--r-- | doc/api/fs.md | 4 | ||||
-rw-r--r-- | doc/api/http.md | 6 | ||||
-rw-r--r-- | doc/api/os.md | 15 | ||||
-rw-r--r-- | doc/api/stream.md | 77 |
5 files changed, 25 insertions, 89 deletions
diff --git a/doc/api/crypto.md b/doc/api/crypto.md index 37a2f41a10..7d7e913db1 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -2652,18 +2652,18 @@ the `crypto`, `tls`, and `https` modules and are generally specific to OpenSSL. </tr> <tr> <td><code>RSA_PSS_SALTLEN_DIGEST</code></td> - <td>Sets the salt length for `RSA_PKCS1_PSS_PADDING` to the digest size - when signing or verifying.</td> + <td>Sets the salt length for <code>RSA_PKCS1_PSS_PADDING</code> to the + digest size when signing or verifying.</td> </tr> <tr> <td><code>RSA_PSS_SALTLEN_MAX_SIGN</code></td> - <td>Sets the salt length for `RSA_PKCS1_PSS_PADDING` to the maximum - permissible value when signing data.</td> + <td>Sets the salt length for <code>RSA_PKCS1_PSS_PADDING</code> to the + maximum permissible value when signing data.</td> </tr> <tr> <td><code>RSA_PSS_SALTLEN_AUTO</code></td> - <td>Causes the salt length for `RSA_PKCS1_PSS_PADDING` to be determined - automatically when verifying a signature.</td> + <td>Causes the salt length for <code>RSA_PKCS1_PSS_PADDING</code> to be + determined automatically when verifying a signature.</td> </tr> <tr> <td><code>POINT_CONVERSION_COMPRESSED</code></td> diff --git a/doc/api/fs.md b/doc/api/fs.md index e879402346..282b2ddaec 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -4378,8 +4378,8 @@ The following constants are meant for use with `fs.open()`. <tr> <td><code>O_NOATIME</code></td> <td>Flag indicating reading accesses to the file system will no longer - result in an update to the `atime` information associated with the file. - This flag is available on Linux operating systems only.</td> + result in an update to the <code>atime</code> information associated with + the file. This flag is available on Linux operating systems only.</td> </tr> <tr> <td><code>O_NOFOLLOW</code></td> diff --git a/doc/api/http.md b/doc/api/http.md index 3c86e856d2..0b1340556b 100644 --- a/doc/api/http.md +++ b/doc/api/http.md @@ -1912,9 +1912,9 @@ changes: Authorization header. * `agent` {http.Agent | boolean} Controls [`Agent`][] behavior. Possible values: - * `undefined` (default): use [`http.globalAgent`][] for this host and port. - * `Agent` object: explicitly use the passed in `Agent`. - * `false`: causes a new `Agent` with default values to be used. + * `undefined` (default): use [`http.globalAgent`][] for this host and port. + * `Agent` object: explicitly use the passed in `Agent`. + * `false`: causes a new `Agent` with default values to be used. * `createConnection` {Function} A function that produces a socket/stream to use for the request when the `agent` option is not used. This can be used to avoid creating a custom `Agent` class just to override the default diff --git a/doc/api/os.md b/doc/api/os.md index 8db4904d29..b7bd246f97 100644 --- a/doc/api/os.md +++ b/doc/api/os.md @@ -442,7 +442,7 @@ The following signal constants are exported by `os.constants.signals`: <tr> <td><code>SIGINT</code></td> <td>Sent to indicate when a user wishes to interrupt a process - (`(Ctrl+C)`).</td> + (<code>(Ctrl+C)</code>).</td> </tr> <tr> <td><code>SIGQUIT</code></td> @@ -855,9 +855,9 @@ The following error constants are exported by `os.constants.errno`: </tr> <tr> <td><code>EOPNOTSUPP</code></td> - <td>Indicates that an operation is not supported on the socket. - Note that while `ENOTSUP` and `EOPNOTSUPP` have the same value on Linux, - according to POSIX.1 these error values should be distinct.)</td> + <td>Indicates that an operation is not supported on the socket. Note that + while <code>ENOTSUP</code> and <code>EOPNOTSUPP</code> have the same value + on Linux, according to POSIX.1 these error values should be distinct.)</td> </tr> <tr> <td><code>EOVERFLOW</code></td> @@ -1114,7 +1114,8 @@ The following error codes are specific to the Windows operating system: </tr> <tr> <td><code>WSAVERNOTSUPPORTED</code></td> - <td>Indicates that the `winsock.dll` version is out of range.</td> + <td>Indicates that the <code>winsock.dll</code> version is out of + range.</td> </tr> <tr> <td><code>WSANOTINITIALISED</code></td> @@ -1197,8 +1198,8 @@ information. </tr> <tr> <td><code>RTLD_LOCAL</code></td> - <td>The converse of `RTLD_GLOBAL`. This is the default behavior if neither - flag is specified.</td> + <td>The converse of <code>RTLD_GLOBAL</code>. This is the default behavior + if neither flag is specified.</td> </tr> <tr> <td><code>RTLD_DEEPBIND</code></td> diff --git a/doc/api/stream.md b/doc/api/stream.md index 9896c596c8..578a1cd140 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -1421,77 +1421,12 @@ class MyWritable extends Writable { The new stream class must then implement one or more specific methods, depending on the type of stream being created, as detailed in the chart below: -<table> - <thead> - <tr> - <th> - <p>Use-case</p> - </th> - <th> - <p>Class</p> - </th> - <th> - <p>Method(s) to implement</p> - </th> - </tr> - </thead> - <tr> - <td> - <p>Reading only</p> - </td> - <td> - <p>[`Readable`](#stream_class_stream_readable)</p> - </td> - <td> - <p><code>[_read][stream-_read]</code></p> - </td> - </tr> - <tr> - <td> - <p>Writing only</p> - </td> - <td> - <p>[`Writable`](#stream_class_stream_writable)</p> - </td> - <td> - <p> - <code>[_write][stream-_write]</code>, - <code>[_writev][stream-_writev]</code>, - <code>[_final][stream-_final]</code> - </p> - </td> - </tr> - <tr> - <td> - <p>Reading and writing</p> - </td> - <td> - <p>[`Duplex`](#stream_class_stream_duplex)</p> - </td> - <td> - <p> - <code>[_read][stream-_read]</code>, - <code>[_write][stream-_write]</code>, - <code>[_writev][stream-_writev]</code>, - <code>[_final][stream-_final]</code></p> - </td> - </tr> - <tr> - <td> - <p>Operate on written data, then read the result</p> - </td> - <td> - <p>[`Transform`](#stream_class_stream_transform)</p> - </td> - <td> - <p> - <code>[_transform][stream-_transform]</code>, - <code>[_flush][stream-_flush]</code>, - <code>[_final][stream-_final]</code> - </p> - </td> - </tr> -</table> +| Use-case | Class | Method(s) to implement | +| -------- | ----- | ---------------------- | +| Reading only | [`Readable`] | <code>[_read][stream-_read]</code> | +| Writing only | [`Writable`] | <code>[_write][stream-_write]</code>, <code>[_writev][stream-_writev]</code>, <code>[_final][stream-_final]</code> | +| Reading and writing | [`Duplex`] | <code>[_read][stream-_read]</code>, <code>[_write][stream-_write]</code>, <code>[_writev][stream-_writev]</code>, <code>[_final][stream-_final]</code> | +| Operate on written data, then read the result | [`Transform`] | <code>[_transform][stream-_transform]</code>, <code>[_flush][stream-_flush]</code>, <code>[_final][stream-_final]</code> | The implementation code for a stream should *never* call the "public" methods of a stream that are intended for use by consumers (as described in the |