TimelyDataflow / TimelyDataflow/timely-dataflow
Improving doc_tests
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 3.6k
- Forks
- 293
- Avg merge
- 14h 46m
- Merged PRs (30d)
- 4
Description
Document tests, examples written into the documentation for structs, methods, and modules, do a great job of explaining how one might use the associated code. They are also somewhat rare in the code at the moment. Occasionally this is because the associated code is terrifying and shouldn't be used, but when this isn't the case (or shouldn't be the case), we can improve the situation with better examples.
Document test PRs are much loved, especially ones that demonstrate the fundamental features of the code with some sort of test at the end showing what should be true about the result or behavior.
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
No files, tests, or entry points are named. Survey the Rust structs, methods, and modules whose documentation lacks examples, starting with code that is intended for normal use rather than code described as terrifying. Done means adding documentation examples with a test at the end that demonstrates the expected result or behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation, testing
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100