Repository navigation
[BUG] Wrong docstrings for attribute when aliased from another class #141
Description
Describe the bug
As you can see here: https://github.com/aminalaee/sqladmin/blob/main/sqladmin/models.py#L358
We have defined a member to be equal to an external third-party class:
class X:
form_base_class = wtforms.Form
"""Some docstrings"""When this class is parsed the parser follows the docstrings in the third-party package and doesn't show the docstrings defined in my docs:
I think either we shouldn't allow this to happen or there should be an option to control this.
As a workaround we found that we can try mkdocstrings-python package but that doesn't follow the members attribute we set and shows unwanted members:
To Reproduce
It's already in the description.
Expected behavior
Screenshots
If you are using pytkdocs through mkdocstrings and if relevant, please attach a screenshot.
System (please complete the following information):
pytkdocsversion [e.g. 0.2.1]- Python version: [e.g. 3.8]
- OS: [Windows/Linux]
Additional context
Add any other context about the problem here.
Activity
[-][BUG] S[/-][+][BUG] Wrong docstrings for attribute when aliased from another class[/+]dwreeves commentedon Mar 24, 2022
Two more bits of additional context.
(1.)
the design pattern of aliasing a class definition as a class variable can be seen in a few projects that use Sphinx docs, such as:
^ So personally, I was expecting behavior similar to this as the default.
(2.)
Maybe it is possible that @aminalaee disagrees with me, but as far as I am concerned, it is unclear whether the true problem is (A) that
pytkdocsdoesn't override and obj's.__doc__when there's a docstring below an attribute, or (B) thatpython-mkdocstrings, which uses griffe, doesn't have amembersattribute (as already mentioned by Amin, griffe resolves the docstring properly whereaspytkdocsdoes not).As far as I can tell, implementing a solution to either 1 of the 2 problems above would seem to work for the sqladmin documentation?
pawamoy commentedon Mar 31, 2022
Hi, thanks for the report. That's a very good understanding of the current situation. Griffe and the new handler will definitely support
members. In the meantime, it's probably possible to fix pytkdocs so that it uses the docstring below an assignment even if the value of the assignment is an object with a__doc__attribute. This won't be a top priority to me so a PR would be welcome 😄pawamoy commentedon Sep 23, 2026
Project is now archived.