-
-
Notifications
You must be signed in to change notification settings - Fork 33.9k
test: conver html table in README.md to markdown table #14291
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
Conversation
|
commit my first doc change |
Trott
left a comment
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. I think it's important for us to keep our README files comprehensible when viewed as plain text as much as we can. Thanks for the contribution!
test/README.md
Outdated
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.
A nit: error in the link format.
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.
Let's make sure this gets fixed before we land. (Or whoever lands it can fix it)
cjihrig
left a comment
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 with nit addressed.
tniessen
left a comment
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 with #14291 (comment) addressed
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.
There are some inconsistencies apart from #14291 (comment):
- Why do some lines end with a
|while others don't? - You sometimes put a space before
|and sometimes not. - Some lines contain unnecessary whitespace between words (e.g. here).
Also, the line lengths have become quite ugly, but I guess there is no way around when working with MD tables.
|
I agree with @tniessen. |
Agreed, but I think the html table looks worse. |
PR-URL: nodejs#14291 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
|
I fixed up the nits and landed in Thanks for the contribution! 🎉 |
|
Let's try again... I fixed up the nits and landed in 85939bd. Thanks for the contribution! 🎉 |
PR-URL: #14291 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passesAffected core subsystem(s)