Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: make markdown input compliant #21780

Closed
wants to merge 3 commits into from
Closed

doc: make markdown input compliant #21780

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ee8fff0
doc: make markdown input compliant
rubys Jul 12, 2018
2e933dc
find lint issues and address comment
rubys Jul 12, 2018
44ea288
avoid redeclaring already declared refs
rubys Jul 14, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions doc/api/crypto.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2671,18 +2671,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>
Expand Down
4 changes: 2 additions & 2 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
6 changes: 3 additions & 3 deletions doc/api/http.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1900,9 +1900,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.
Copy link
Member

@ChALkeR ChALkeR Jul 13, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can this (proper padding) be enforced by remark-lint?

* `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
Expand Down
15 changes: 8 additions & 7 deletions doc/api/os.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
77 changes: 6 additions & 71 deletions doc/api/stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1419,77 +1419,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
Expand Down