Skip to content

Commit 91dedbd

Browse files
Merge pull request #2315 from lolbinarycat/rustdoc-gui-readme
add some links about the rustdoc-gui test suite
2 parents eb02e6b + 7fda61b commit 91dedbd

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

src/rustdoc.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,9 @@ does is call the `main()` that's in this crate's `lib.rs`, though.)
9090
are in `tests/rustdoc-gui`. These use a [NodeJS tool called
9191
browser-UI-test](https://github.com/GuillaumeGomez/browser-UI-test/) that uses
9292
puppeteer to run tests in a headless browser and check rendering and
93-
interactivity.
93+
interactivity. For information on how to write this form of test,
94+
see [`tests/rustdoc-gui/README.md`][rustdoc-gui-readme]
95+
as well as [the description of the `.goml` format][goml-script]
9496
* Additionally, JavaScript type annotations are written using [TypeScript-flavored JSDoc]
9597
comments and an external d.ts file. The code itself is plain, valid JavaScript; we only
9698
use tsc as a linter.
@@ -100,6 +102,8 @@ does is call the `main()` that's in this crate's `lib.rs`, though.)
100102
[These tests have several extra directives available to them](./rustdoc-internals/rustdoc-test-suite.md).
101103

102104
[TypeScript-flavored JSDoc]: https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html
105+
[rustdoc-gui-readme]: https://github.com/rust-lang/rust/blob/master/tests/rustdoc-gui/README.md
106+
[goml-script]: https://github.com/GuillaumeGomez/browser-UI-test/blob/master/goml-script.md
103107

104108
## Constraints
105109

0 commit comments

Comments
 (0)