Couldn't read PEP-224 variable docstrings from x
Open
Nobody has claimed this yet.
bug
upstream
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 146
- PR merge metrics
- No merged PRs in 30d
Description
Expected Behavior
pdoc3 ignores .py files without docstrings.
Actual Behavior
pdoc3 throws a UserWarning exception "Couldn't read PEP-224 variable docstrings from ..."
Steps to Reproduce
- run pdoc3 on a .py file without a docstring
Additional info
- pdoc version: 0.8.1
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
Reproduce the warning by running pdoc3 0.8.1 on a .py file without a module docstring, as described in the issue. Trace the PEP-224 variable-docstring handling reached by that command; done means such files are ignored without raising the reported UserWarning.
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
- Mostly clear
- Newbie friendliness
- 35/100