Commit 8c2b179
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: #35708
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>1 parent a5fa849 commit 8c2b179
2 files changed
Lines changed: 2 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -580,7 +580,7 @@ test-hash-seed: all | |||
| 580 | 580 | $(NODE) test/pummel/test-hash-seed.js | |
| 581 | 581 | ||
| 582 | 582 | .PHONY: test-doc | |
| 583 | - test-doc: doc-only lint ## Builds, lints, and verifies the docs. | ||
| 583 | + test-doc: doc-only lint-md ## Builds, lints, and verifies the docs. | ||
| 584 | 584 | @if [ "$(shell $(node_use_openssl))" != "true" ]; then \ | |
| 585 | 585 | echo "Skipping test-doc (no crypto)"; \ | |
| 586 | 586 | else \ | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -16,7 +16,7 @@ this guide. | |||
| 16 | 16 | * Documents should be word-wrapped at 80 characters. | |
| 17 | 17 | * `.editorconfig` describes the preferred formatting. | |
| 18 | 18 | * A [plugin][] is available for some editors to apply these rules. | |
| 19 | - * Check changes to documentation with `make lint-md`. | ||
| 19 | + * Check changes to documentation with `make test-doc -j` or `vcbuild test-doc`. | ||
| 20 | 20 | * [Use US spelling][]. | |
| 21 | 21 | * [Use serial commas][]. | |
| 22 | 22 | * Avoid first-person pronouns (_I_, _we_). | |
0 commit comments