diff options
| author | Guillaume Gomez <guillaume1.gomez@gmail.com> | 2025-04-03 22:09:48 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-04-03 22:09:48 +0200 |
| commit | a1d345f93cbc53bc56f098deff9255bc7d5041ea (patch) | |
| tree | 857547ddaee7658f6bd4a8d99c9419471a29ec86 | |
| parent | b69d514464dcd0288a9b4749cf90c2491151c1cb (diff) | |
| parent | ceba464c696f8a5c8585e1c479c758a0a6241d47 (diff) | |
| download | rust-a1d345f93cbc53bc56f098deff9255bc7d5041ea.tar.gz rust-a1d345f93cbc53bc56f098deff9255bc7d5041ea.zip | |
Merge pull request #2315 from lolbinarycat/rustdoc-gui-readme
add some links about the rustdoc-gui test suite
| -rw-r--r-- | src/doc/rustc-dev-guide/src/rustdoc.md | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/src/doc/rustc-dev-guide/src/rustdoc.md b/src/doc/rustc-dev-guide/src/rustdoc.md index 320dc9d5825..e36d6a388a9 100644 --- a/src/doc/rustc-dev-guide/src/rustdoc.md +++ b/src/doc/rustc-dev-guide/src/rustdoc.md @@ -90,7 +90,9 @@ does is call the `main()` that's in this crate's `lib.rs`, though.) are in `tests/rustdoc-gui`. These use a [NodeJS tool called browser-UI-test](https://github.com/GuillaumeGomez/browser-UI-test/) that uses puppeteer to run tests in a headless browser and check rendering and - interactivity. + 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. @@ -100,6 +102,8 @@ does is call the `main()` that's in this crate's `lib.rs`, though.) [These tests have several extra directives available to them](./rustdoc-internals/rustdoc-test-suite.md). [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 +[goml-script]: https://github.com/GuillaumeGomez/browser-UI-test/blob/master/goml-script.md ## Constraints |