lambdaclass / lambdaclass/spawned
Convert examples to doc tests
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Rust
- Stars
- 59
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
Description
- Create examples in READMEs (crate-specific)
- Include READMEs as module docs in crate root
- Convert examples to doctests for CI automation
Closes #62.
Part of Phase 5 (Documentation).
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 crate-specific READMEs and crate roots to identify the examples and module documentation that need to be connected. Convert the README examples into Rust doctests and run the project's CI or test commands to confirm the examples are checked automatically.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100