-
Notifications
You must be signed in to change notification settings - Fork 29.6k
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: consistent unordered list style #29516
doc: consistent unordered list style #29516
Conversation
bf53da5
to
ad5de3b
Compare
Is there a preference for using Prettier, a popular code formatter uses > cat > test.md
Test
* One
* Two
^C
> npx prettier test.md
Test
- One
- Two |
I actually prefer |
Some results from grep in node repo: > grep -r --include=\*.md '^* ' ./ | wc -l
46352
> grep -r --include=\*.md '^\- ' ./ | wc -l
6176
|
This can be enforced with https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint-ordered-list-marker-style afterwards |
This PR accidentally altered YAML front-matter, breaking It seems like an awfully big change set (1943 changed lines in its current form) and there might be other issues in there like this. I kind of doubt anyone actually reviewed all the changes here and instead rubber-stamped it. I'm not sure we should do it. It seems like we're doing it to be consistent for the sake of being consistent, which isn't terrible or anything, but it doesn't seem that using If it's possible to set the linter so that it requires one or the other in each file, but rejecting a mixture of both in a single file, that might be an acceptable first step towards eventually making them all consistent. I'm not going to block this but I'm kind of -0 on it. |
Thanks, I'll take a look at that
Most of the changed files were because they were mixed
Nope, different across docs is fine. The only issue that can really arise from mixed is if they are accidentally used at the same level, then multiple unorded lists are created. Can't recall if I actually saw any in here |
007a547
to
d15fd5d
Compare
|
d15fd5d
to
2d86d5c
Compare
2d86d5c
to
2db627e
Compare
Convert to astericks when there are mixed styles in document. Addresses Markdownlint MD004 rule
dab098f
to
f2bd82f
Compare
Landed in e2dcbf1 |
Convert to asterisks when there are mixed styles in document. Addresses Markdownlint MD004 rule PR-URL: #29516 Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Thanks, I'll look at adding that to the remark-lint config if you don't get to it first |
Convert to asterisks when there are mixed styles in document. Addresses Markdownlint MD004 rule PR-URL: #29516 Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Convert to asterisks when there are mixed styles in document. Addresses Markdownlint MD004 rule PR-URL: #29516 Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Erroneously removed in nodejs#29516. Fixes: nodejs#31810 Refs: nodejs#29516
Erroneously removed in #29516. Fixes: #31810 Refs: #29516 PR-URL: #31825 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Erroneously removed in #29516. Fixes: #31810 Refs: #29516 PR-URL: #31825 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Erroneously removed in #29516. Fixes: #31810 Refs: #29516 PR-URL: #31825 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Erroneously removed in #29516. Fixes: #31810 Refs: #29516 PR-URL: #31825 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Erroneously removed in #29516. Fixes: #31810 Refs: #29516 PR-URL: #31825 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Checklist
make -j4 test
(UNIX), orvcbuild test
(Windows) passes