doc: make markdown input compliant - #21780
Conversation
Sorry, something went wrong.
Trott
left a comment
There was a problem hiding this comment.
🎉
Sorry, something went wrong.
|
We have some md lint issues: https://travis-ci.com/nodejs/node/jobs/134224344 |
Sorry, something went wrong.
|
@rubys FYI, on non-Windows, you can install the markdown linter with make lint-md-build and run it with make lint-md. (If it's not installed, markdown linting gets skipped when you run make test or make lint locally.) |
Sorry, something went wrong.
|
(And if you're on Windows, it should work with vcbuild instead of make...) |
Sorry, something went wrong.
BridgeAR
left a comment
There was a problem hiding this comment.
LGTM with the comments addressed :)
Sorry, something went wrong.
| </table> | ||
| | Use-case | Class | Method(s) to implement | | ||
| | -------- | ----- | ---------------------- | | ||
| | Reading only |[`Readable`](#stream_class_stream_readable) |[_read][stream-_read]</code> | |
There was a problem hiding this comment.
The </code> part should likely have a beginning?
Sorry, something went wrong.
| | Use-case | Class | Method(s) to implement | | ||
| | -------- | ----- | ---------------------- | | ||
| | Reading only |[`Readable`](#stream_class_stream_readable) |[_read][stream-_read]</code> | | ||
| |Writing only |[`Writable`](#stream_class_stream_writable) | <code>[_write][stream-_write]</code>, <code>[_writev][stream-_writev]</code>, <code>[_final][stream-_final]</code> | |
There was a problem hiding this comment.
Nit: a whitespace at the beginning of each part would be nice.
Sorry, something went wrong.
Sorry, something went wrong.
| * `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. |
There was a problem hiding this comment.
Can this (proper padding) be enforced by remark-lint?
Sorry, something went wrong.
| </table> | ||
| | Use-case | Class | Method(s) to implement | | ||
| | -------- | ----- | ---------------------- | | ||
| | Reading only | [`Readable`](#stream_class_stream_readable) | <code>[_read][stream-_read]</code> | |
There was a problem hiding this comment.
Why not [`Readable`][], [`Writable`][], [`Duplex`][], [`Transform`][]? That should make lines shorter.
Side note: there could be a test for that, i.e. to avoid redeclaring already declared refs.
Sorry, something went wrong.
Sorry, something went wrong.
|
Node.js Collaborators, please, add 👍 here if you approve fast-tracking. |
Sorry, something went wrong.
PR-URL: #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>
PR-URL: #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>
Checklist