python / python/docs-community
ABC documentation needs more details on usage
Nobody has claimed this yet.
- Dominant language
- Makefile
- Stars
- 55
- Forks
- 26
- PR merge metrics
- No merged PRs in 30d
Description
I am trying to use Abstract Base Classes. But I find the documentation lacking on several points that makes the matter too 'abstract'.
For example. There is no explanation on making abstract objects mandatory by using exceptions
Or how to implement Iterable abstract bsse class that can be inherited from and still be usable.
Can someone shed more light onto this so that the documentation is more accessible?
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 locating the Abstract Base Classes documentation and reviewing its current coverage of abstract objects, exceptions, and Iterable inheritance. Done means the documentation clearly explains the requested usage patterns and makes the examples accessible to readers; no specific files or tests are named in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100