scylladb / scylladb/python-rs-driver
Add information about exceptions to docstring in public API
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 6
- Forks
- 7
- Avg merge
- 5d 13h
- Merged PRs (30d)
- 9
Description
Currently we have some scaffolding of error hierarchy. For relatively stable public API we should include and maintain information about errors (or rather exceptions) the method or property may raise (if any) when called or accessed.
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
The issue names no files, tests, or specific API entry points. Locate the public API docstrings and existing exception hierarchy, then determine which methods or properties can raise each exception; the work is done when the relevant exception information is documented and maintainable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 45/100