Inner classes are showing as class variables
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 146
- PR merge metrics
- No merged PRs in 30d
Description
Expected Behavior
I would expect an inner class to document similarly to an outer class.
Actual Behavior
The class gets documented as a class variable.
Steps to Reproduce
- Create a python module that contains a class and document with a docstring.
- Add an inner class, also with documentation.
- Build the documentation.
- See an example here: https://westy.github.io/pyseext/component_query.html
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 by reproducing the issue with a Python module containing an outer class and a documented inner class, then compare the generated output with the example at westy.github.io/pyseext/component_query.html. Trace how pdoc 0.10.0 identifies and renders class members. Done means the inner class is documented like the outer class rather than shown as a class variable.
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
- 42/100