Run doc tests on README
Open
Nobody has claimed this yet.
A-readme
C-feature-request
Command-test
S-needs-design
- Dominant language
- Rust
- Stars
- 15.5k
- Forks
- 3k
- Avg merge
- 23h 30m
- Merged PRs (30d)
- 51
Description
cargo test could run (the equivalent of) rustdoc --test README.md, since people often have a basic example in it.
See also
- #739
- doc-comment
- cargo-readme
Past efforts
- #445
Contributor guide
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 Cargo's cargo test behavior and compare the requested equivalent of rustdoc --test README.md; review related issues #739 and #445, along with the doc-comment and cargo-readme references. Done means README examples are exercised by cargo test with behavior consistent with the requested documentation tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- build-system, testing
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100