Document when Bound::new can return an Err
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Rust
- Stars
- 16.2k
- Forks
- 1k
- Avg merge
- 2d 6h
- Merged PRs (30d)
- 66
Description
Bound::new returns a Result, but the API documentation (https://pyo3.rs/main/doc/pyo3/struct.bound#method.new) doesn't explain when this can be the Err variant.
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 the Bound::new API documentation at the linked PyO3 reference and inspect the surrounding method documentation and implementation context to determine when it returns Err. Update the documentation to state those conditions clearly; the linked API page should explain the error cases when done.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100