Skip to content

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

Merged
aduh95 merged 2 commits into
nodejs:masterfrom
Trott:format-doc-api
Oct 20, 2021
Merged

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

Conversation

@Trott

@Trott Trott commented Oct 11, 2021

Copy link
Copy Markdown
Member

No description provided.

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to Node.js documentation. label Oct 11, 2021
@targos

ghost commented Oct 11, 2021 •
edited by targos
Loading

Copy link
Copy Markdown
Member

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

aduh95
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
Trott force-pushed the format-doc-api branch 2 times, most recently from d0e8013 to 37c63bd Compare October 11, 2021 14:00
@Trott

ghost 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

ghost 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://github.com/proxy/gist.github.com/Trott/0b5070042d8b2198e4f0d036fbfa606b

aduh95
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
Trott force-pushed the format-doc-api branch 8 times, most recently from 10fd7b2 to 90865c5 Compare October 13, 2021 06:07
@Trott

This comment has been minimized.

Sign in to view
@Trott Trott added the author ready PRs with CI started, the required approvals, and no outstanding review comments. label Oct 13, 2021
@targos

ghost commented Oct 13, 2021

Copy link
Copy Markdown
Member

It seems to break doc generation.

@Trott

This comment has been minimized.

Sign in to view
@Trott Trott removed the author ready PRs with CI started, the required approvals, and no outstanding review comments. label Oct 13, 2021
@Trott

This comment has been minimized.

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

ghost 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
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
targos approved these changes Oct 13, 2021
View reviewed changes

ghost 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.

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
Trott force-pushed the format-doc-api branch 7 times, most recently from a7bd829 to b83c938 Compare October 20, 2021 05:12
@Trott

ghost 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 Trott mentioned this pull request Oct 20, 2021
Closed
@Trott

ghost commented Oct 20, 2021

Copy link
Copy Markdown
Member Author

Please backport to v16.x-staging ASAP

#40530

@Trott Trott added the author ready PRs with CI started, the required approvals, and no outstanding review comments. label Oct 20, 2021
aduh95
aduh95 approved these changes Oct 20, 2021
View reviewed changes

ghost 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.

LGTM, thanks for all the work!

Rich Trott added 2 commits October 20, 2021 11:59
Rich Trott
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>
Rich Trott
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

ghost commented Oct 20, 2021

Copy link
Copy Markdown
Contributor

Landed in 4cb3e06...d0b58c0

@aduh95
aduh95 merged commit d0b58c0 into nodejs:master Oct 20, 2021
@Trott
Trott deleted the format-doc-api branch October 20, 2021 14:07
@targos targos mentioned this pull request Oct 20, 2021
Merged
@Trott Trott mentioned this pull request Oct 20, 2021
Closed
@BethGriggs BethGriggs mentioned this pull request Nov 26, 2021
Merged
1 task done
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

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

Assignees

No one assigned

Labels

author ready PRs with CI started, the required approvals, and no outstanding review comments. doc Issues and PRs related to Node.js documentation.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@Trott @targos @aduh95 @benjamingr @Lxxyx @nodejs-github-bot