GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — doc: format doc/api/*.md with markdown formatter by Trott · Pull Request #40403 · nodejs/node

Conversation

@Trott

@Trott Trott commented Oct 11, 2021

Copy link
Copy Markdown
Member

No description provided.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to Node.js documentation. label Oct 11, 2021
benjamingr
benjamingr approved these changes Oct 11, 2021
View reviewed changes
Lxxyx
Lxxyx approved these changes Oct 11, 2021
View reviewed changes
@targos

targos commented Oct 11, 2021 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

aduh95
aduh95 reviewed Oct 11, 2021
View reviewed changes
Comment thread doc/api/child_process.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/api/repl.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/api/repl.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/api/repl.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/api/tty.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/api/cli.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

@Trott
Trott force-pushed the format-doc-api branch 2 times, most recently from d0e8013 to 37c63bd Compare October 11, 2021 14:00
@Trott

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.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@Trott

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

aduh95
aduh95 reviewed Oct 11, 2021
View reviewed changes
Comment thread doc/api/cli.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/api/errors.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/api/errors.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/api/esm.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/api/esm.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/api/fs.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/api/fs.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/api/n-api.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/api/net.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/api/process.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

@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

targos commented Oct 13, 2021

Copy link
Copy Markdown
Member

It seems to break doc generation.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@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

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.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

aduh95
aduh95 reviewed Oct 13, 2021
View reviewed changes
Comment thread doc/api/n-api.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/api/net.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/api/readline.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/api/tls.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/api/webstreams.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/api/webstreams.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/api/worker_threads.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

targos
targos approved these changes Oct 13, 2021
View reviewed changes

@targos targos left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

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 🙏🏻

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
Comment thread doc/api/tls.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/api/webstreams.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/api/webstreams.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/api/n-api.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

@Trott
Trott force-pushed the format-doc-api branch from d936976 to f4df473 Compare October 13, 2021 14:16
@Trott
Trott force-pushed the format-doc-api branch 7 times, most recently from a7bd829 to b83c938 Compare October 20, 2021 05:12
@Trott

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@Trott Trott mentioned this pull request Oct 20, 2021
[v16.x backport] doc: format doc/api/*.md with markdown formatter #40530
Closed
@Trott

Trott commented Oct 20, 2021

Copy link
Copy Markdown
Member Author

Please backport to v16.x-staging ASAP

#40530

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@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

@aduh95 aduh95 left a comment

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

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!

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
Trott added 2 commits October 20, 2021 11:59
@Trott @aduh95
test: adjust CLI flags test to ignore blank lines in doc
a7c17e0
PR-URL: nodejs#40403
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: Zijian Liu <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
@Trott @aduh95
doc: format doc/api/*.md with markdown formatter
d0b58c0
PR-URL: nodejs#40403
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: Zijian Liu <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
@aduh95
aduh95 force-pushed the format-doc-api branch from b83c938 to d0b58c0 Compare October 20, 2021 10:00
@aduh95

aduh95 commented Oct 20, 2021

Copy link
Copy Markdown
Contributor

Landed in 4cb3e06...d0b58c0

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@aduh95
aduh95 merged commit d0b58c0 into nodejs:master Oct 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 <[email protected]>
Reviewed-By: Zijian Liu <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
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 <[email protected]>
Reviewed-By: Zijian Liu <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
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 <[email protected]>
Reviewed-By: Zijian Liu <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
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 <[email protected]>
Reviewed-By: Zijian Liu <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
@targos targos mentioned this pull request Oct 20, 2021
v17.0.1 release proposal #40535
Merged
@Trott Trott mentioned this pull request Oct 20, 2021
doc: add missing entry in globals.md #40531
Closed
@targos targos added the backport-open-v16.x label Nov 4, 2021
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 <[email protected]>
Reviewed-By: Zijian Liu <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
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 <[email protected]>
Reviewed-By: Zijian Liu <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
@targos targos added backported-to-v16.x and removed backport-open-v16.x labels Nov 4, 2021
@BethGriggs BethGriggs mentioned this pull request Nov 26, 2021
v16.13.1 proposal #40974
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

Uh oh!

There was an error while loading. Please reload this page.

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.

Uh oh!

There was an error while loading. Please reload this page.

6 participants

@Trott @targos @aduh95 @benjamingr @Lxxyx @nodejs-github-bot
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.