You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I have the case where multiple classes (Derived Classes) - which are implementations of a Base Class - do not inherit the docstrings of abstract functions and attributes of the latter. Although I looked it up I could not really find some option to enable it. I mostly need this cause in the general inheritance case I wouldn't want to make the code verbose with copies of the same docstring in the function & properties of each of the derived class.
Looking up the issues I found this one #224. But it does not quite fit my case.
I think that it should be sth similar to Sphinx's autodoc_inherit_docstrings = True
The text was updated successfully, but these errors were encountered:
ktsitsi
changed the title
Inherit docstrings from Base to Derived Class.
Inherit docstrings from Base to Derived Class
Oct 13, 2023
Hey, thanks for raising this! There is some discussion on mkdocstrings/griffe#96 about adding this functionality to griffe, the tool we use to find python objects.
I think we should have everything to add an inherit_docstrings option to quartodoc, but haven't implemented yet.
I have the case where multiple classes (Derived Classes) - which are implementations of a Base Class - do not inherit the docstrings of abstract functions and attributes of the latter. Although I looked it up I could not really find some option to enable it. I mostly need this cause in the general inheritance case I wouldn't want to make the code verbose with copies of the same docstring in the function & properties of each of the derived class.
Looking up the issues I found this one #224. But it does not quite fit my case.
I think that it should be sth similar to Sphinx's
autodoc_inherit_docstrings = True
The text was updated successfully, but these errors were encountered: