rust-lang / rust-lang/rustc-dev-guide
add notes about `rustdoc-ui` and `rustdoc-js` tests
Open
Nobody has claimed this yet.
A-test-suite
C-enhancement
E-help-wanted
E-medium
T-rustdoc
- Dominant language
- HTML
- Stars
- 1.9k
- Forks
- 613
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 39
Description
While reviewing https://github.com/rust-lang/rust/pull/50302 i noticed that these test folders aren't mentioned in the testing chapter at all. Since the linked PR adds a special configuration flag to the rustdoc-js tests, it would be worth mentioning it in the testing guide.
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 with the testing chapter and compare its coverage with the rustdoc-ui and rustdoc-js test folders. Review the linked pull request for the special rustdoc-js configuration flag, then update the guide so both test folders and that flag are documented.
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