about summary refs log tree commit diff
diff options
context:
space:
mode:
authorTshepang Mbambo <tshepang@gmail.com>2025-05-06 14:56:51 +0200
committerGitHub <noreply@github.com>2025-05-06 14:56:51 +0200
commit6e966d75fd6349d1aee76b9a49dcd7e11206b000 (patch)
treee0518e27607f8d40fa06bf0670e7185f555f6e54
parentbf06eaf7a2e8ad08c23a3d8da1255cdcc4174c55 (diff)
downloadrust-6e966d75fd6349d1aee76b9a49dcd7e11206b000.tar.gz
rust-6e966d75fd6349d1aee76b9a49dcd7e11206b000.zip
avoid duplicating commands
The 2 commands do the same thing.
Also, follow style used elsewhere in the guide.
-rw-r--r--src/doc/rustc-dev-guide/src/tests/intro.md9
1 files changed, 5 insertions, 4 deletions
diff --git a/src/doc/rustc-dev-guide/src/tests/intro.md b/src/doc/rustc-dev-guide/src/tests/intro.md
index 7bf30b106b4..c55d60f4a5c 100644
--- a/src/doc/rustc-dev-guide/src/tests/intro.md
+++ b/src/doc/rustc-dev-guide/src/tests/intro.md
@@ -102,11 +102,12 @@ by passing a path to a book to `./x test`.
 
 ### Documentation link checker
 
-Links across all documentation is validated with a link checker tool.
+Links across all documentation is validated with a link checker tool,
+and it can be invoked so:
 
-> Example: `./x test src/tools/linkchecker`
-
-> Example: `./x test linkchecker`
+```console
+./x test linkchecker
+```
 
 This requires building all of the documentation, which might take a while.