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: update benchmarks README.md for upcoming linting/formatting #40158

Merged
merged 1 commit into from
Sep 22, 2021

Conversation

Trott
Copy link
Member

@Trott Trott commented Sep 19, 2021

No description provided.

@nodejs-github-bot nodejs-github-bot added the benchmark Issues and PRs related to the benchmark subsystem. label Sep 19, 2021
@Trott Trott changed the title doc: update benchamrks README.md for upcoming linting/formatting doc: update benchmarks README.md for upcoming linting/formatting Sep 19, 2021
@Trott Trott added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Sep 20, 2021
@@ -32,7 +32,7 @@ directory, see [the guide on benchmarks](../doc/guides/writing-and-running-bench
| module | Benchmarks for the `module` subsystem. |
| net | Benchmarks for the `net` subsystem. |
| path | Benchmarks for the `path` subsystem. |
| perf_hooks | Benchmarks for the `perf_hooks` subsystem. |
| perf\_hooks | Benchmarks for the `perf_hooks` subsystem. |
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
| perf\_hooks | Benchmarks for the `perf_hooks` subsystem. |
| perf\_hooks | Benchmarks for the `perf_hooks` subsystem. |

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed. Thanks. I'm pretty sure that consistent alignment of pipes in the text representation of tables is something that can be configured in the formatter, so I'll look into doing that.

Copy link
Member Author

Choose a reason for hiding this comment

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

Turns out it's the default with remark-gfm which we use in the linter, so this will happen automatically when we start using the linter for the formatter. I was omitting gfm when running remark on the command line, but I won't do that in subsequent PRs. Thanks again!

PR-URL: nodejs#40158
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@Trott
Copy link
Member Author

Trott commented Sep 22, 2021

Landed in a6a5d4b

@Trott Trott merged commit a6a5d4b into nodejs:master Sep 22, 2021
@Trott Trott deleted the benchmark-md branch September 22, 2021 00:02
targos pushed a commit that referenced this pull request Oct 4, 2021
PR-URL: #40158
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
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. benchmark Issues and PRs related to the benchmark subsystem.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants