diff options
| author | Michael Howell <michael@notriddle.com> | 2024-08-23 17:22:49 -0700 |
|---|---|---|
| committer | Michael Goulet <michael@errs.io> | 2024-09-15 14:53:28 -0400 |
| commit | 1f5fe0631c2d7da3b90f39f87ccc81e8510354b6 (patch) | |
| tree | 162630d0cf3768641485a20bf98ff904256ce341 /src/doc/rustc-dev-guide | |
| parent | 3195e48cd771ab4b7a0c31519788b4d2d2759d73 (diff) | |
| download | rust-1f5fe0631c2d7da3b90f39f87ccc81e8510354b6.tar.gz rust-1f5fe0631c2d7da3b90f39f87ccc81e8510354b6.zip | |
Further clarification
Diffstat (limited to 'src/doc/rustc-dev-guide')
| -rw-r--r-- | src/doc/rustc-dev-guide/src/rustdoc-internals/search.md | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/src/doc/rustc-dev-guide/src/rustdoc-internals/search.md b/src/doc/rustc-dev-guide/src/rustdoc-internals/search.md index 41f2ee0b1a0..dc7be250e7b 100644 --- a/src/doc/rustc-dev-guide/src/rustdoc-internals/search.md +++ b/src/doc/rustc-dev-guide/src/rustdoc-internals/search.md @@ -380,8 +380,11 @@ The `.js` file is like a module (except the loader takes care of `FILTER_CRATE` can be left out (equivalent to searching "all crates"), but you have to specify `EXPECTED` or `PARSED`. -By default, the test fails if any of the expected results are missing, -or if the results don't appear in the specified order. + + +By default, the test fails if any of the results specified in the test case are +not found after running the search, or if the results found after running the +search don't appear in the same order that they do in the test. The actual search results may, however, include results that aren't in the test. To override this, specify any of the following magic comments. Put them on their own line, without indenting. |