Skip to content

Commit

Permalink
doc: recommend test-doc instead of lint-md
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
aduh95 authored and targos committed Nov 3, 2020
1 parent a5fa849 commit 8c2b179
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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 \
Expand Down
2 changes: 1 addition & 1 deletion doc/guides/doc-style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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_).
Expand Down

0 comments on commit 8c2b179

Please sign in to comment.