Skip to content

Commit 72a2d0e

Browse files
authored
Rollup merge of rust-lang#83420 - GuillaumeGomez:rustdoc-gui-tests-doc, r=CraftSpider
Add documentation for rustdoc-gui tests I think a bit of documentation doesn't hurt in this case considering how "out of the ordinary" this is. r? ``@jyn514``
2 parents 29e64e9 + c8dbb59 commit 72a2d0e

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

src/test/rustdoc-gui/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
The tests present here are used to test the generated HTML from rustdoc. The
2+
goal is to prevent unsound/unexpected GUI changes.
3+
4+
This is using the [browser-ui-test] framework to do so. It works as follows:
5+
6+
It wraps [puppeteer] to send commands to a web browser in order to navigate and
7+
test what's being currently displayed in the web page.
8+
9+
You can find more information and its documentation in its [repository][browser-ui-test].
10+
11+
[browser-ui-test]: https://github.com/GuillaumeGomez/browser-UI-test/
12+
[puppeteer]: https://pptr.dev/

0 commit comments

Comments
 (0)