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

@TrottTrott commented Oct 11, 2021

Copy link
Copy Markdown
Member

No description provided.

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

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
aduh95 reviewed Oct 11, 2021
View reviewed changes
Comment threaddoc/api/child_process.md Outdated
Comment threaddoc/api/repl.md Outdated
Comment threaddoc/api/repl.md Outdated
Comment threaddoc/api/repl.md Outdated
Comment threaddoc/api/tty.md Outdated
Comment threaddoc/api/cli.md Outdated
@Trott
Trottforce-pushed the format-doc-api branch 2 times, most recently from d0e8013 to 37c63bdCompareOctober 11, 2021 14:00
@Trott

Trott commented Oct 11, 2021

Copy link
Copy Markdown
MemberAuthor

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

Trott commented Oct 11, 2021

Copy link
Copy Markdown
MemberAuthor

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
aduh95 reviewed Oct 11, 2021
View reviewed changes
Comment threaddoc/api/cli.md Outdated
Comment threaddoc/api/errors.md Outdated
Comment threaddoc/api/errors.md Outdated
Comment threaddoc/api/esm.md Outdated
Comment threaddoc/api/esm.md Outdated
Comment threaddoc/api/fs.md Outdated
Comment threaddoc/api/fs.md Outdated
Comment threaddoc/api/n-api.md Outdated
Comment threaddoc/api/net.md Outdated
Comment threaddoc/api/process.md Outdated
@Trott
Trottforce-pushed the format-doc-api branch 8 times, most recently from 10fd7b2 to 90865c5CompareOctober 13, 2021 06:07
@Trott

This comment has been minimized.

Sign in to view
@TrottTrott added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Oct 13, 2021
@targos

targos 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
@TrottTrott removed the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Oct 13, 2021
@Trott

This comment has been minimized.

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

Trott commented Oct 13, 2021

Copy link
Copy Markdown
MemberAuthor

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 threaddoc/api/n-api.md Outdated
Comment threaddoc/api/net.md Outdated
Comment threaddoc/api/readline.md Outdated
Comment threaddoc/api/tls.md Outdated
Comment threaddoc/api/webstreams.md Outdated
Comment threaddoc/api/webstreams.md Outdated
Comment threaddoc/api/worker_threads.md Outdated
targos
targos approved these changes Oct 13, 2021
View reviewed changes

@targostargos 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 threaddoc/api/tls.md Outdated
Comment threaddoc/api/webstreams.md Outdated
Comment threaddoc/api/webstreams.md Outdated
Comment threaddoc/api/n-api.md Outdated
@Trott
Trottforce-pushed the format-doc-api branch 7 times, most recently from a7bd829 to b83c938CompareOctober 20, 2021 05:12
@Trott

Trott commented Oct 20, 2021

Copy link
Copy Markdown
MemberAuthor

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

@TrottTrott mentioned this pull request Oct 20, 2021
Closed
@Trott

Trott commented Oct 20, 2021

Copy link
Copy Markdown
MemberAuthor

Please backport to v16.x-staging ASAP

#40530

@TrottTrott added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Oct 20, 2021
aduh95
aduh95 approved these changes Oct 20, 2021
View reviewed changes

@aduh95aduh95 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!

@Trott@aduh95
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>
@Trott@aduh95
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

aduh95 commented Oct 20, 2021

Copy link
Copy Markdown
Contributor

Landed in 4cb3e06...d0b58c0

@aduh95
aduh95 merged commit d0b58c0 into nodejs:masterOct 20, 2021
@Trott
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
@Trott
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
@Trott
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
@Trott@targos
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
@Trott@targos
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>
@targostargos mentioned this pull request Oct 20, 2021
Merged
@TrottTrott mentioned this pull request Oct 20, 2021
Closed
targos pushed a commit that referenced this pull request Nov 4, 2021
@Trott@targos
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
@Trott@targos
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>
@BethGriggsBethGriggs mentioned this pull request Nov 26, 2021
Merged
1 task
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@benjamingrbenjamingrbenjamingr approved these changes
@targostargostargos approved these changes
@LxxyxLxxyxLxxyx approved these changes
@aduh95aduh95aduh95 approved these changes

Assignees

No one assigned

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.docIssues and PRs related to the documentations.

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