mirror
/
rustc-dev-guide
mirror of https://github.com/rust-lang/rustc-dev-guide.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Minor wording improvements

This commit is contained in:
Michael Howell 2024-08-23 10:59:11 -07:00 committed by Michael Goulet
parent 953292a349
commit 305fbac89a
1 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/rustdoc-internals/search.md
View File

@ -369,8 +369,7 @@ The `rustdoc-js-std` tests are the same, but don't require an `.rs`
file, since they use the standard library. file, since they use the standard library.
The `.js` file is like a module (except the loader takes care of The `.js` file is like a module (except the loader takes care of
`exports` for you). It expects you to set these variables in the `exports` for you). It uses these variables:
module's scope:
| Name | Type | Description | Name | Type | Description
| -------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------- | -------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------
@ -378,6 +377,9 @@ module's scope:
| `EXPECTED` | `[ResultsTable]\|ResultsTable` | List of tests to run, specifying what the hypothetical user types into the search box and sees in the tabs | `EXPECTED` | `[ResultsTable]\|ResultsTable` | List of tests to run, specifying what the hypothetical user types into the search box and sees in the tabs
| `PARSED` | `[ParsedQuery]\|ParsedQuery` | List of parser tests to run, without running an actual search | `PARSED` | `[ParsedQuery]\|ParsedQuery` | List of parser tests to run, without running an actual search
`FILTER_CRATE` can be left out (equivalent to searching "all crates"), but you
have to specify `EXPECTED` or `PARSED`.
Additionally, the following magic comments are supported. Additionally, the following magic comments are supported.
Put them on their own line, without indenting. Put them on their own line, without indenting.
@ -390,12 +392,9 @@ Put them on their own line, without indenting.
to minor scoring changes. to minor scoring changes.
* `// should-fail`: Used to write negative tests. * `// should-fail`: Used to write negative tests.
Standard library tests probably shouldn't specify any of these (we want the Standard library tests usually shouldn't specify `// exact-check`, since we
libs team to be able to add new stuff without causing our tests to fail), but want the libs team to be able to add new items without causing unrelated
standalone tests will often want `// exact-check`. tests to fail, but standalone tests will use it more often.
`FILTER_CRATE` can be left out (equivalent to searching "all crates"), but you
have to specify `EXPECTED` or `PARSED`.
The `ResultsTable` and `ParsedQuery` types are specified in The `ResultsTable` and `ParsedQuery` types are specified in
[`externs.js`](https://github.com/rust-lang/rust/blob/master/src/librustdoc/html/static/js/externs.js). [`externs.js`](https://github.com/rust-lang/rust/blob/master/src/librustdoc/html/static/js/externs.js).