FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: format doc/api/*.md with markdown formatter by Trott · Pull Request #40403 · nodejs/node · GitHub

/ node Public

doc: format doc/api/*.md with markdown formatter - #40403

Merged
aduh95 merged 2 commits into
nodejs:masterfrom
Trott:format-doc-api
Oct 20, 2021
ConversationCommits (2)ChecksFiles changed
Merged

doc: format doc/api/*.md with markdown formatter#40403
aduh95 merged 2 commits into
nodejs:masterfrom
Trott:format-doc-api

Conversation

Trott commented Oct 11, 2021

Copy link
Copy Markdown
Member

No description provided.

nodejs-github-bot added the doc Issues and PRs related to the documentations. label Oct 11, 2021

targos commented Oct 11, 2021 •
edited
Loading

Copy link
Copy Markdown
Member

Is there a way to view the diff without the empty new lines?

aduh95 reviewed Oct 11, 2021
View reviewed changes
Comment thread doc/api/child_process.md Outdated
Comment thread doc/api/repl.md Outdated
Comment thread doc/api/repl.md Outdated
Comment thread doc/api/repl.md Outdated
Comment thread doc/api/tty.md Outdated
Comment thread doc/api/cli.md Outdated
Trott force-pushed the format-doc-api branch 2 times, most recently from d0e8013 to 37c63bd Compare October 11, 2021 14:00

Trott commented Oct 11, 2021

Copy link
Copy Markdown
Member Author

Is there a way to view the diff without the empty new lines?

While I don't think there is a way to do that in the GitHub interface, you can do git diff --ignore-blank-lines upstream/master if you are reviewing this branch on the command line.

Trott commented Oct 11, 2021

Copy link
Copy Markdown
Member Author

Is there a way to view the diff without the empty new lines?

While I don't think there is a way to do that in the GitHub interface, you can do git diff --ignore-blank-lines upstream/master if you are reviewing this branch on the command line.

And if it saves anyone any trouble, here's what that will look like as of now: https://gist.github.com/Trott/0b5070042d8b2198e4f0d036fbfa606b

aduh95 reviewed Oct 11, 2021
View reviewed changes
Comment thread doc/api/cli.md Outdated
Comment thread doc/api/errors.md Outdated
Comment thread doc/api/errors.md Outdated
Comment thread doc/api/esm.md Outdated
Comment thread doc/api/esm.md Outdated
Comment thread doc/api/fs.md Outdated
Comment thread doc/api/fs.md Outdated
Comment thread doc/api/n-api.md Outdated
Comment thread doc/api/net.md Outdated
Comment thread doc/api/process.md Outdated
Trott force-pushed the format-doc-api branch 8 times, most recently from 10fd7b2 to 90865c5 Compare October 13, 2021 06:07

This comment has been minimized.

Sign in to view
Trott added the author ready PRs that have at least one approval, no outstanding review comments, and a CI started. label Oct 13, 2021

targos commented Oct 13, 2021

Copy link
Copy Markdown
Member

It seems to break doc generation.

This comment has been minimized.

Sign in to view
Trott removed the author ready PRs that have at least one approval, no outstanding review comments, and a CI started. label Oct 13, 2021

This comment has been minimized.

Sign in to view
Trott force-pushed the format-doc-api branch 2 times, most recently from eb826f0 to d936976 Compare October 13, 2021 06:23

Trott commented Oct 13, 2021

Copy link
Copy Markdown
Member Author

It seems to break doc generation.

Well, that's bad....

Looks like I mistakenly added extra levels of headers when I did that mass n-api header edit.

All fixed up.

aduh95 reviewed Oct 13, 2021
View reviewed changes
Comment thread doc/api/n-api.md Outdated
Comment thread doc/api/net.md Outdated
Comment thread doc/api/readline.md Outdated
Comment thread doc/api/tls.md Outdated
Comment thread doc/api/webstreams.md Outdated
Comment thread doc/api/webstreams.md Outdated
Comment thread doc/api/worker_threads.md Outdated
targos approved these changes Oct 13, 2021
View reviewed changes

targos left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Changes in esm.md are a bit annoying, but I can live with them.

Please backport to v16.x-staging ASAP 🙏🏻

Comment thread doc/api/tls.md Outdated
Comment thread doc/api/webstreams.md Outdated
Comment thread doc/api/webstreams.md Outdated
Comment thread doc/api/n-api.md Outdated
Trott force-pushed the format-doc-api branch 7 times, most recently from a7bd829 to b83c938 Compare October 20, 2021 05:12

Trott commented Oct 20, 2021

Copy link
Copy Markdown
Member Author

All comments have been addressed I believe. Theoretically, this can land, but it would be good to have at least a quick review or re-review with the changes that were just made. Maybe @aduh95? (Although they've already done plenty on this one in terms of reviewing.)

Trott mentioned this pull request Oct 20, 2021
Closed

Trott commented Oct 20, 2021

Copy link
Copy Markdown
Member Author

Please backport to v16.x-staging ASAP

#40530

Trott added the author ready PRs that have at least one approval, no outstanding review comments, and a CI started. label Oct 20, 2021
aduh95 approved these changes Oct 20, 2021
View reviewed changes

aduh95 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM, thanks for all the work!

Trott added 2 commits October 20, 2021 11:59
test: adjust CLI flags test to ignore blank lines in doc
a7c17e0 
PR-URL: nodejs#40403
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Zijian Liu <lxxyxzj@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
doc: format doc/api/*.md with markdown formatter
d0b58c0 
PR-URL: nodejs#40403
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Zijian Liu <lxxyxzj@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>

aduh95 commented Oct 20, 2021

Copy link
Copy Markdown
Contributor

Landed in 4cb3e06...d0b58c0

aduh95 merged commit d0b58c0 into nodejs:master Oct 20, 2021
Trott deleted the format-doc-api branch October 20, 2021 14:07
Trott added a commit to Trott/io.js that referenced this pull request Oct 20, 2021
test: adjust CLI flags test to ignore blank lines in doc
038121b 
PR-URL: nodejs#40403
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Zijian Liu <lxxyxzj@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Trott added a commit to Trott/io.js that referenced this pull request Oct 20, 2021
doc: format doc/api/*.md with markdown formatter
ab54a10 
PR-URL: nodejs#40403
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Zijian Liu <lxxyxzj@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
targos pushed a commit that referenced this pull request Oct 20, 2021
test: adjust CLI flags test to ignore blank lines in doc
3f7c503 
PR-URL: #40403
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Zijian Liu <lxxyxzj@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
targos pushed a commit that referenced this pull request Oct 20, 2021
doc: format doc/api/*.md with markdown formatter
8dce85a 
PR-URL: #40403
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Zijian Liu <lxxyxzj@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
targos mentioned this pull request Oct 20, 2021
Merged
Trott mentioned this pull request Oct 20, 2021
Closed
targos pushed a commit that referenced this pull request Nov 4, 2021
test: adjust CLI flags test to ignore blank lines in doc
6de88bc 
PR-URL: #40403
Backport-PR-URL: #40530
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Zijian Liu <lxxyxzj@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
targos pushed a commit that referenced this pull request Nov 4, 2021
doc: format doc/api/*.md with markdown formatter
621266a 
PR-URL: #40403
Backport-PR-URL: #40530
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Zijian Liu <lxxyxzj@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
BethGriggs mentioned this pull request Nov 26, 2021
Merged
1 task
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

benjamingr benjamingr approved these changes
Lxxyx Lxxyx approved these changes
aduh95 aduh95 approved these changes
+1 more reviewer
targos targos approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

author ready PRs that have at least one approval, no outstanding review comments, and a CI started. doc Issues and PRs related to the documentations.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

Back | FazBrowse Home | New Git URL