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
Describe the bug
I've set inherited_memberse to true in my selector to pull in members that are inherited from classes that I've built. Essentially, I have a class Mergeable, that has some methods and attributes, and many classes inherit from it. However, this is also applying to Enum and is pulling in noise.
To Reproduce
Use mkdocs+mkdocstring on a Python file that has an Enum in it, and set inherited_members to true.
Expected behavior
The class and similar aspects shouldn't be collected. There's no point in documenting these are part of mkdocs.
System (please complete the following information):
pytkdocs version 0.11.1
Python version: 3.8.2
OS: MacOS
The text was updated successfully, but these errors were encountered:
Whether we should filter out members starting with __ is up to discussion 🙂
Personally I want my documented special methods to appear in the docs (__init__). But I agree it can quickly become noisy with inherited members.
Agree, though maybe special handling there? Does it make sense to pull __bool__ and __class__, for example? __init__ may be a special one, and only if it's non empty?
Describe the bug
I've set inherited_memberse to true in my selector to pull in members that are inherited from classes that I've built. Essentially, I have a class Mergeable, that has some methods and attributes, and many classes inherit from it. However, this is also applying to Enum and is pulling in noise.
To Reproduce
Use mkdocs+mkdocstring on a Python file that has an Enum in it, and set inherited_members to true.
Expected behavior
The class and similar aspects shouldn't be collected. There's no point in documenting these are part of mkdocs.
System (please complete the following information):
pytkdocs
version 0.11.1The text was updated successfully, but these errors were encountered: