rigetti / rigetti/rigetti-pyo3
Add test cases for the generated documentation
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 11
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
As discovered when working on #51, adding test cases for the generated documentation is fragile. It's sufficiently fragile that committing the documentation and relying on manual inspection is a significantly better choice; the design space for how to test the macro expansions is unfortunately large. This issue is thus for testing the documentation added by #51 (see also #50).
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 reading issues #51 and #50 to understand the generated documentation and the macro expansions it contains. Define a practical test strategy for that documentation; done means test cases cover the documentation from #51 without relying solely on manual inspection.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation, testing
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100