rust-lang / rust-lang/rustc-dev-guide
description of rustdoc test suites is scattered
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 1.9k
- Forks
- 613
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 39
Description
There are at least 3 pages that describe the structure of the tests/rustdoc* folders.
- https://rustc-dev-guide.rust-lang.org/tests/compiletest.html#rustdoc-test-suites
- https://rustc-dev-guide.rust-lang.org/rustdoc.html#tests
- 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)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the three rustc-dev-guide sections named in the issue: compiletest.html#rustdoc-test-suites, rustdoc.html#tests, and rustdoc-internals.html#dotting-is-and-crossing-ts. Decide whether to connect them or consolidate their overlapping explanations, preserving short guidance at old locations when needed; done means readers can navigate the rustdoc test-suite documentation coherently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100