diff options
| author | nora <48135649+Noratrieb@users.noreply.github.com> | 2025-05-23 18:56:05 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-05-23 18:56:05 +0200 |
| commit | 6232b33c6c6d672dfd4541673745464f4e11a3c9 (patch) | |
| tree | 1c756a54829250b7214193fe0cc43fee06bab327 /src/doc/rustc-dev-guide | |
| parent | 419ba5d28e2981379324f25d7a8062ed231cf41f (diff) | |
| parent | 34411547fb40d95c313dada70a01104676c65df0 (diff) | |
| download | rust-6232b33c6c6d672dfd4541673745464f4e11a3c9.tar.gz rust-6232b33c6c6d672dfd4541673745464f4e11a3c9.zip | |
Merge pull request #2404 from lolbinarycat/patch-1
rustdoc.md: reorder list so test suites are not split up
Diffstat (limited to 'src/doc/rustc-dev-guide')
| -rw-r--r-- | src/doc/rustc-dev-guide/src/rustdoc.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/src/doc/rustc-dev-guide/src/rustdoc.md b/src/doc/rustc-dev-guide/src/rustdoc.md index 3139dfc63fd..de70ba63823 100644 --- a/src/doc/rustc-dev-guide/src/rustdoc.md +++ b/src/doc/rustc-dev-guide/src/rustdoc.md @@ -93,13 +93,13 @@ does is call the `main()` that's in this crate's `lib.rs`, though.) interactivity. For information on how to write this form of test, see [`tests/rustdoc-gui/README.md`][rustdoc-gui-readme] as well as [the description of the `.goml` format][goml-script] -* Additionally, JavaScript type annotations are written using [TypeScript-flavored JSDoc] - comments and an external d.ts file. The code itself is plain, valid JavaScript; we only - use tsc as a linter. -* The tests on the structure of rustdoc HTML output are located in `tests/rustdoc`, +* Tests on the structure of rustdoc HTML output are located in `tests/rustdoc`, where they're handled by the test runner of bootstrap and the supplementary script `src/etc/htmldocck.py`. [These tests have several extra directives available to them](./rustdoc-internals/rustdoc-test-suite.md). +* Additionally, JavaScript type annotations are written using [TypeScript-flavored JSDoc] + comments and an external d.ts file. The code itself is plain, valid JavaScript; we only + use tsc as a linter. [TypeScript-flavored JSDoc]: https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html [rustdoc-gui-readme]: https://github.com/rust-lang/rust/blob/master/tests/rustdoc-gui/README.md |