Skip to content

Commit

Permalink
doc: mention markdown linting in BUILDING.md
Browse files Browse the repository at this point in the history
BUILDING.md mentioned JS and C++ linting were performed
in the 'make lint' command, but 'make lint' also
performs markdown linting. This commit updates the docs
to include markdown as one of the things being linted.

PR-URL: #28578
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
  • Loading branch information
srcmake authored and targos committed Jul 20, 2019
1 parent f0e4bf9 commit 70c3116
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -322,8 +322,7 @@ Make sure the linter does not report any issues and that all tests pass. Please
do not submit patches that fail either check.

If you want to run the linter without running tests, use
`make lint`/`vcbuild lint`. It will run both JavaScript linting and
C++ linting.
`make lint`/`vcbuild lint`. It will lint JavaScript, C++, and Markdown files.

If you are updating tests and want to run tests in a single test file
(e.g. `test/parallel/test-stream2-transform.js`):
Expand Down

0 comments on commit 70c3116

Please sign in to comment.