Start documenting tests/rustdoc-json #2422
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aDotInTheVoid
force-pushed
the
tenthousandyears
branch
from
27c7a0d to
abd8c05
Compare
This was referenced May 28, 2025
jyn514
approved these changes
May 28, 2025
There was a problem hiding this comment.
could you link to here from https://rustc-dev-guide.rust-lang.org/rustdoc.html#tests ?
| @@ -155,7 +155,8 @@ The bulk of [`rustdoc`] is in [`librustdoc`]. However, the [`rustdoc`] binary | |||
| itself is [`src/tools/rustdoc`], which does nothing except call [`rustdoc::main`]. | |||
|
|
|||
| There is also `JavaScript` and `CSS` for the docs in [`src/tools/rustdoc-js`] | |||
| and [`src/tools/rustdoc-themes`]. | |||
| and [`src/tools/rustdoc-themes`]. The type definitions for `--output-format=json` | |||
| are in a seperate crate in [`src/rustdoc-json-types`]. | |||
There was a problem hiding this comment.
Suggested change
| are in a seperate crate in [`src/rustdoc-json-types`]. | |
| are in a separate crate in [`src/rustdoc-json-types`]. |
| This page is specifically about the test suite named `rustdoc-json`, which tests rustdoc's [json output]. | ||
| For other test suites used for testing rustdoc, see [Rustdoc tests](../rustdoc.md#tests). | ||
|
|
||
| Tests are run with compiletest, and have access to the usuall set of [directives](../tests/directives.md). |
There was a problem hiding this comment.
Suggested change
| Tests are run with compiletest, and have access to the usuall set of [directives](../tests/directives.md). | |
| Tests are run with compiletest, and have access to the usual set of [directives](../tests/directives.md). |
| For other test suites used for testing rustdoc, see [Rustdoc tests](../rustdoc.md#tests). | ||
|
|
||
| Tests are run with compiletest, and have access to the usuall set of [directives](../tests/directives.md). | ||
| Frequenly used directives here are: |
There was a problem hiding this comment.
Suggested change
| Frequenly used directives here are: | |
| Frequently used directives here are: |
| ## jsondoclint | ||
|
|
||
| [jsondoclint] checks that all [`Id`]s exist in the `index` (or `paths`). | ||
| This makes sure their are no dangling [`Id`]s. |
There was a problem hiding this comment.
Suggested change
| This makes sure their are no dangling [`Id`]s. | |
| This makes sure there are no dangling [`Id`]s. |
Comment on lines
+30
to
+38
| - `//@ has <path>`:: Checks `<path>` exists, i.e. matches at least 1 value. | ||
| - `//@ !has <path>`:: Checks `<path>` doesn't exist, i.e. matches 0 values. | ||
| - `//@ has <path> <value>`: Check `<path>` exists, and 1 of the matches is equal to the given `<value>` | ||
| - `//@ !has <path> <value>`: Checks `<path>` exists, but none of the matches equal the given `<value>`. | ||
| - `//@ is <path> <value>`: Check `<path>` matches exacly one value, and it's equal to the given `<value>`. | ||
| - `//@ is <path> <value> <value>...`: Check that `<path>` matches to exactly every given `<value>`. | ||
| Ordering doesn't matter here. | ||
| - `//@ !is <path> <value>`: Check `<path>` matches exactly one value, and that value is not equal to the given `<value>`. | ||
| - `//@ count <path> <number>` Check that `<path>` matches to `<number>` of values. |
There was a problem hiding this comment.
can you link to an exhaustive reference of the directives? source code is fine, just somewhere to look if a new directive gets added and i can't find it in the dev guide.
|
|
||
| - `//@ has <path>`:: Checks `<path>` exists, i.e. matches at least 1 value. | ||
| - `//@ !has <path>`:: Checks `<path>` doesn't exist, i.e. matches 0 values. | ||
| - `//@ has <path> <value>`: Check `<path>` exists, and 1 of the matches is equal to the given `<value>` |
There was a problem hiding this comment.
i imagine you mean "at least one", right? otherwise this is equivalent to @ is.
jieyouxu
added
A-test-suite
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes rust-lang/rust#100515