show_inherited_members doesn't work for empty docstring
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
method1 should display as method2 but with mark "Inherited from".
Actual Behavior
method1 of class test2 is not displayed.
Steps to Reproduce
- Clone https://github.com/MarshalX/pydoc_issue.
- Run command from readme.
Additional info
If I add a docstring to method1, it will appear (method0 as an example). I would like to appear this method with an empty docstring.
- pdoc version: pdoc3 0.9.2
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
Clone https://github.com/MarshalX/pydoc_issue and run the command from its README to reproduce the missing method1 output. Read pdoc3's inherited-member handling and compare method1 with the documented method0 and method2 cases. Done means method1 appears with the "Inherited from" mark even when its docstring is empty.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100