diff options
| author | binarycat <binarycat@envs.net> | 2025-03-18 13:23:37 -0500 |
|---|---|---|
| committer | binarycat <binarycat@envs.net> | 2025-03-18 13:23:37 -0500 |
| commit | 40b9be0c456d32cf01441ec1c96fec1523d4737f (patch) | |
| tree | a8e8eaad2e0f5fd49bccf39836290cea48794881 | |
| parent | 1081d98cf679560b02f6db4b2d72bb3103b92073 (diff) | |
| download | rust-40b9be0c456d32cf01441ec1c96fec1523d4737f.tar.gz rust-40b9be0c456d32cf01441ec1c96fec1523d4737f.zip | |
clean up wording/grammar and mention double quotes
| -rw-r--r-- | src/doc/rustc-dev-guide/src/SUMMARY.md | 2 | ||||
| -rw-r--r-- | src/doc/rustc-dev-guide/src/rustdoc-internals/rustdoc-test-suite.md | 7 |
2 files changed, 5 insertions, 4 deletions
diff --git a/src/doc/rustc-dev-guide/src/SUMMARY.md b/src/doc/rustc-dev-guide/src/SUMMARY.md index 8ea5e86cd63..075d5af4c24 100644 --- a/src/doc/rustc-dev-guide/src/SUMMARY.md +++ b/src/doc/rustc-dev-guide/src/SUMMARY.md @@ -95,7 +95,7 @@ - [Parallel Compilation](./parallel-rustc.md) - [Rustdoc internals](./rustdoc-internals.md) - [Search](./rustdoc-internals/search.md) - - [the `rustdoc` test suite](./rustdoc-internals/rustdoc-test-suite.md) + - [The `rustdoc` test suite](./rustdoc-internals/rustdoc-test-suite.md) # Source Code Representation - [Prologue](./part-3-intro.md) diff --git a/src/doc/rustc-dev-guide/src/rustdoc-internals/rustdoc-test-suite.md b/src/doc/rustc-dev-guide/src/rustdoc-internals/rustdoc-test-suite.md index 97c40c8a820..fb4be51c278 100644 --- a/src/doc/rustc-dev-guide/src/rustdoc-internals/rustdoc-test-suite.md +++ b/src/doc/rustc-dev-guide/src/rustdoc-internals/rustdoc-test-suite.md @@ -1,6 +1,6 @@ -# the `rustdoc` test suite +# The `rustdoc` test suite -This page is specifically about the `rustdoc` test suite, for other test suites used for testing rustdoc, see [Rustdoc ยง Tests](../rustdoc.md#tests). +This page is specifically about the test suite named `rustdoc`, for other test suites used for testing rustdoc, see [Rustdoc Tests](../rustdoc.md#tests). The `rustdoc` test suite is specifically used to test the HTML output of rustdoc. @@ -20,7 +20,8 @@ so it is conventional to use a `#![crate_name = "foo"]` attribute to avoid having to write a long crate name multiple times. To avoid repetion, `-` can be used in any `PATH` argument to re-use the previous `PATH` argument. -All arguments take the form of quoted strings, +All arguments take the form of quoted strings +(both single and double quotes are supported), with the exception of `COUNT` and the special `-` form of `PATH`. Directives are assertions that place constraints on the generated HTML. |