Giters

mkdocstrings / pytkdocs

Load Python objects documentation.

Home Page:https://mkdocstrings.github.io/pytkdocs

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

[BUG] Enum's __class__ etc. are pulled in when inherited_members is true

yi2020 opened this issue · comments

commented

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.

Screen Shot 2021-05-17 at 11 36 28 AM

Screen Shot 2021-05-17 at 11 41 10 AM

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
commented

BTW - workaround was to filter anything that starts with __, but the default behavior shouldn't require this.

commented

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.

commented

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?