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.

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

doc: make markdown input compliant #21780

Closed
wants to merge 3 commits into from

Conversation

rubys
Copy link
Member

@rubys rubys commented Jul 12, 2018

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • commit message follows commit guidelines

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Jul 12, 2018
Copy link
Member

@Trott Trott left a comment

Choose a reason for hiding this comment

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

🎉

@Trott Trott mentioned this pull request Jul 12, 2018
2 tasks
@vsemozhetbyt
Copy link
Contributor

We have some md lint issues: https://travis-ci.com/nodejs/node/jobs/134224344

@Trott
Copy link
Member

Trott commented Jul 12, 2018

@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.)

@Trott
Copy link
Member

Trott commented Jul 12, 2018

(And if you're on Windows, it should work with vcbuild instead of make...)

Copy link
Member

@BridgeAR BridgeAR left a comment

Choose a reason for hiding this comment

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

LGTM with the comments addressed :)

</table>
| Use-case | Class | Method(s) to implement |
| -------- | ----- | ---------------------- |
| Reading only |[`Readable`](#stream_class_stream_readable) |[_read][stream-_read]</code> |
Copy link
Member

Choose a reason for hiding this comment

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

The </code> part should likely have a beginning?

| 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> |
Copy link
Member

Choose a reason for hiding this comment

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

Nit: a whitespace at the beginning of each part would be nice.

@BridgeAR
Copy link
Member

@BridgeAR BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jul 13, 2018
* `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

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?

</table>
| Use-case | Class | Method(s) to implement |
| -------- | ----- | ---------------------- |
| Reading only | [`Readable`](#stream_class_stream_readable) | <code>[_read][stream-_read]</code> |
Copy link
Member

Choose a reason for hiding this comment

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

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.

@vsemozhetbyt
Copy link
Contributor

@vsemozhetbyt
Copy link
Contributor

Node.js Collaborators, please, add 👍 here if you approve fast-tracking.

vsemozhetbyt pushed a commit that referenced this pull request Jul 15, 2018
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>
@vsemozhetbyt
Copy link
Contributor

Landed in 6a99e3e
Thank you!

targos pushed a commit that referenced this pull request Jul 16, 2018
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>
@targos targos mentioned this pull request Jul 17, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants