diff options
| author | Antoine du Hamel <duhamelantoine1995@gmail.com> | 2020-10-19 12:58:55 +0200 |
|---|---|---|
| committer | Antoine du Hamel <duhamelantoine1995@gmail.com> | 2020-10-30 12:01:58 +0100 |
| commit | 30e9fab8667746115f0076617469e866d564f053 (patch) | |
| tree | 72e18acfb59fd2abe8caf9c614df6a863ef4af07 | |
| parent | b90e1353be02d2cc097d478040e399c52d3db0f1 (diff) | |
| download | node-new-30e9fab8667746115f0076617469e866d564f053.tar.gz | |
doc: recommend test-doc instead of lint-md
The documentation style guide used to recommend checking changes in the
docs by running `make lint-md`. This leaves out some important checks
which are contained in the `test-doc` build target. This commit also
replaces `lint` by `lint-md` in the list of `test-doc`'s prerequisites.
PR-URL: https://github.com/nodejs/node/pull/35708
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
| -rw-r--r-- | Makefile | 2 | ||||
| -rw-r--r-- | doc/guides/doc-style-guide.md | 2 |
2 files changed, 2 insertions, 2 deletions
@@ -580,7 +580,7 @@ test-hash-seed: all $(NODE) test/pummel/test-hash-seed.js .PHONY: test-doc -test-doc: doc-only lint ## Builds, lints, and verifies the docs. +test-doc: doc-only lint-md ## Builds, lints, and verifies the docs. @if [ "$(shell $(node_use_openssl))" != "true" ]; then \ echo "Skipping test-doc (no crypto)"; \ else \ diff --git a/doc/guides/doc-style-guide.md b/doc/guides/doc-style-guide.md index b44206ff9e..ee039e9e83 100644 --- a/doc/guides/doc-style-guide.md +++ b/doc/guides/doc-style-guide.md @@ -16,7 +16,7 @@ this guide. * Documents should be word-wrapped at 80 characters. * `.editorconfig` describes the preferred formatting. * A [plugin][] is available for some editors to apply these rules. -* Check changes to documentation with `make lint-md`. +* Check changes to documentation with `make test-doc -j` or `vcbuild test-doc`. * [Use US spelling][]. * [Use serial commas][]. * Avoid first-person pronouns (_I_, _we_). |