Skip to content

bug: inherited_members does not get docstring for @abstractmethod #233

Closed as not planned
@osamimi

Description

@osamimi

mkdocstrings-python v1.13.0
mkdocstrings[python] v0.27.0
mkdocs-material v9.5.50
mkdocs v1.6.1

With inherited_members globally enabled, and the following example:

class AbstractBase(ABC):
    @abstractmethod
    def example_method(self) -> int:
        """example_method abstractmethod docstring"""
        pass


class MyClass(AbstractBase):
    def example_method(self) -> int:
        return 1

I see the following. Note that Myclass::example_method is listed, but without the docstring that is written in AbstractBase::example_method. I expect to see 'example_method abstractmethod docstring' under Myclass::example_method as well.

Image

Metadata

Metadata

Assignees

Labels

griffe extensionCan be solved with a Griffe extension

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions