user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Rollup merge of #83420 - GuillaumeGomez:rustdoc-gui-tests-doc, r=CraftSpider

Browse source 
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``
This commit is contained in:
Yuki Okushi 2021-03-25 09:07:27 +09:00 • committed by GitHub
commit 72a2d0e386
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

12
src/test/rustdoc-gui/README.md Normal file
View file

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