Pdoc fails if a base class uses a NotImplementedError
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 146
- PR merge metrics
- No merged PRs in 30d
Description
Expected Behavior
No error thrown. I have a base class in a lib that I want to document and some of the methods are deliberately marked as NotImplementedError.
Actual Behavior
_getmembers_all catches only AttributeError. It should also catch NotImplementedError
Steps to Reproduce
- Take any class in an existing library and insert a
raisestatement for aNotImplementedError - Run
pdoc --html some_libwheresome_libis the name of the aforementioned lib.
Additional info
- pdoc version: 0.10.0
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 in the _getmembers_all function identified in the issue and reproduce the failure with pdoc --html some_lib using a class method that raises NotImplementedError. Confirm that documenting the library completes without an error, and use the expected behavior as the completion check.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 48/100