Skip to content

rustdoc: add tests that validate emitted JS and HTML #84356

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
jsha opened this issue Apr 20, 2021 · 1 comment
Open

rustdoc: add tests that validate emitted JS and HTML #84356

jsha opened this issue Apr 20, 2021 · 1 comment
Labels
A-rustdoc-js Area: Rustdoc's JS front-end A-testsuite Area: The testsuite used to check the correctness of rustc T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@jsha
Copy link
Contributor

jsha commented Apr 20, 2021

For the rustdoc tests, it would be great to validate all emitted JS and HTML in a build of the stdlib. For the JavaScript, we could use node -c to check that it parses. For HTML, we could use the W3C Markup Validator or the newer W3C Nu Html Checker.
@jsha jsha added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. A-rustdoc-js Area: Rustdoc's JS front-end labels Apr 20, 2021
@jyn514 jyn514 added the A-testsuite Area: The testsuite used to check the correctness of rustc label Apr 20, 2021
@syvb
Copy link
Contributor

syvb commented Apr 21, 2021

Note that Rustdoc currently outputs invalid HTML in some cases according to the Nu validator.

JS files do currently pass node -c.

@jyn514 jyn514 mentioned this issue Apr 23, 2021
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-rustdoc-js Area: Rustdoc's JS front-end A-testsuite Area: The testsuite used to check the correctness of rustc T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@jsha @Manishearth @syvb @jyn514