Skip to content
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.

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

description of rustdoc test suites is scattered #2260

Open
lolbinarycat opened this issue Feb 24, 2025 · 0 comments
Open

description of rustdoc test suites is scattered #2260

lolbinarycat opened this issue Feb 24, 2025 · 0 comments
Labels
A-test-suite Area: rust-lang/rust test suites I-confusing Issue: info is confusing to readers I-terse Issue: info is very terse T-rustdoc Relevant to rustdoc team

Comments

@lolbinarycat
Copy link
Contributor

There are at least 3 pages that describe the structure of the tests/rustdoc* folders.

  1. https://rustc-dev-guide.rust-lang.org/tests/compiletest.html#rustdoc-test-suites
  2. https://rustc-dev-guide.rust-lang.org/rustdoc.html#tests
  3. https://rustc-dev-guide.rust-lang.org/rustdoc-internals.html#dotting-is-and-crossing-ts

1 links to 2, but otherwise there is no way to navigate between them. Either they should all link to each other, or they should be condensed into a single page (perhaps with some 1 line sections left behind for people who follow links to the old locations)

@fmease fmease added the T-rustdoc Relevant to rustdoc team label Feb 24, 2025
@jieyouxu jieyouxu added I-terse Issue: info is very terse I-confusing Issue: info is confusing to readers A-test-suite Area: rust-lang/rust test suites labels Feb 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-test-suite Area: rust-lang/rust test suites I-confusing Issue: info is confusing to readers I-terse Issue: info is very terse T-rustdoc Relevant to rustdoc team
Projects
None yet
Development

No branches or pull requests

3 participants