doc: fix bulleted list punctuation in BUILDING.md #34849
Conversation
nodejs-github-bot
added
build
|
Shouldn't be any reason for this PR to wait to land once it has appropriate review. Fast-track? Please 👍🏻 |
rickyes
added
the
author ready
BUILDING.md
Outdated
| @@ -531,7 +531,7 @@ to run it again before invoking `make -j4`. | |||
| [Visual Studio 2019](https://visualstudio.microsoft.com/downloads/) or | |||
| the "Visual C++ build tools" workload from the | |||
| [Build Tools](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2019), | |||
| with the default optional components. | |||
| with the default optional components | |||
| * Basic Unix tools required for some tests, | |||
| [Git for Windows](https://git-scm.com/download/win) includes Git Bash | |||
| and tools which can be included in the global `PATH`. | |||
There was a problem hiding this comment.
This bullet is also a single sentence that ends in a period.
There was a problem hiding this comment.
Ideally, everything in the list should be the same structure and also grammatically correct. Unfortunately, this one is neither. It starts with a phrase (like the previous items in the list) and then has a full sentence bolted onto it with a comma-splice.
I'm inclined to leave it for another round of fixing later. This PR is all tiny changes that I think should be uncontroversial. Once I start rewording things, moving stuff around, and adding parentheses or whatever, there may be more bike-shedding (which is fine, but I'd like to keep that separate from the more obvious stuff that can/should land quickly).
Remove/add periods as appropriate in bulleted lists in BUILDING.md. PR-URL: #34849 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Ricky Zhou <[email protected]>
|
Landed in 9fd71a9 |
Trott
force-pushed
the
list-punctuation
branch
from
c76f7c9
to
9fd71a9
Compare
|
@Trott As an aside, this PR is showing 0 commits and 0 file changed, probably because it was closed before GitHub could update status. There's a note about it at the end of https://github.com/nodejs/node/blob/master/doc/guides/collaborator-guide.md#technical-howto. |
Ah, thanks for calling my attention to that! I always push to master before pushing to my branch. Hopefully my muscle-memory won't get in the way of me reversing that process. (Maybe it's time for me to write a script.) |
Remove/add periods as appropriate in bulleted lists in BUILDING.md. PR-URL: #34849 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Ricky Zhou <[email protected]>
Remove/add periods as appropriate in bulleted lists in BUILDING.md.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes