Skip to content

Commit 6893f0a

Browse files
committed
rustdoc test suite: clean up wording and intro
1 parent a172f23 commit 6893f0a

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

src/doc/rustc-dev-guide/src/rustdoc-internals/htmldocck.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
# `rustdoc` tests
1+
# the `rustdoc` test suite
22

33
This page is specifically about the `rustdoc` test suite, for other test suites used for testing rustdoc, see [Rustdoc § Tests](../rustdoc.md#tests).
44

5-
`htmldocck.py` is a custom checker script that uses [XPath] to verify the HTML output of rustdoc.
5+
The `rustdoc` test suite is specifically used to test the HTML output of rustdoc.
6+
7+
This is achived by means of `htmldocck.py`, a custom checker script that leverages [XPath].
68

79
[XPath]: https://en.wikipedia.org/wiki/XPath
810

@@ -14,7 +16,8 @@ In addition to the directives listed here,
1416
[compiletest directives](../tests/directives.html).
1517

1618
All `PATH`s in directives are relative to the the rustdoc output directory (`build/TARGET/test/rustdoc/TESTNAME`),
17-
so it is conventional to use a `#![crate_name = "foo"]` attribute to avoid writing paths.
19+
so it is conventional to use a `#![crate_name = "foo"]` attribute to avoid
20+
having to write a long crate name multiple times.
1821
To avoid repetion, `-` can be used in any `PATH` argument to re-use the previous `PATH` argument.
1922

2023
All arguments take the form of quoted strings,

0 commit comments

Comments
 (0)