Skip to content

Commit f36f645

Browse files
poliorceticsJoshua Nelson
authored andcommitted
Links to htmldocck/@has/matches for searchability
1 parent 1086996 commit f36f645

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

src/rustdoc-internals.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,8 @@ a set of tests in `src/test/rustdoc` that make sure the final HTML is what we
177177
expect in various situations. These tests also use a supplementary script,
178178
`src/etc/htmldocck.py`, that allows it to look through the final HTML using
179179
XPath notation to get a precise look at the output. The full description of all
180-
the commands available to rustdoc tests is in `htmldocck.py`.
180+
the commands available to rustdoc tests (e.g. [`@has`] and [`@matches`]) is in
181+
[`htmldocck.py`].
181182

182183
To use multiple crates in a rustdoc test, add `// aux-build:filename.rs`
183184
to the top of the test file. `filename.rs` should be placed in an `auxiliary`
@@ -193,6 +194,10 @@ that features results in all tabs can be found in `basic.js`. The basic idea is
193194
that you match a given `QUERY` with a set of `EXPECTED` results, complete with
194195
the full item path of each item.
195196

197+
[`htmldocck.py`]: https://github.com/rust-lang/rust/blob/master/src/etc/htmldocck.py
198+
[`@has`]: https://github.com/rust-lang/rust/blob/master/src/etc/htmldocck.py#L39
199+
[`@matches`]: https://github.com/rust-lang/rust/blob/master/src/etc/htmldocck.py#L44
200+
196201
## Testing locally
197202

198203
Some features of the generated HTML documentation might require local

0 commit comments

Comments
 (0)