Skip to content

feature: Filter shown base classes #161

Open
@lars-reimann

Description

@lars-reimann

Is your feature request related to a problem? Please describe.

There is already an option show_bases to fully enable or disable whether base classes are shown. I'd like to be able to hide only internal base classes (name starts with an underscore) but still show the others.

Describe the solution you'd like

An option to filter which base classes are displayed. Maybe the existing filters option could be applied to base classes as well.

Describe alternatives you've considered

  • Add a new value to show_bases like filtered to apply the filters.
  • Separate filter_bases options.

Additional context

This is especially useful when inherited_members is set to true.

Also thanks for the awesome tool, it's a joy to use.

Activity

changed the title [-]feature: filter base classes[/-] [+]feature: filter shown base classes[/+] on May 11, 2024
changed the title [-]feature: filter shown base classes[/-] [+]feature: Filter shown base classes[/+] on May 11, 2024
pawamoy

pawamoy commented on May 12, 2024

@pawamoy
Member

Hello, thanks for the feature request! I agree that it would make sense to filter shown bases in accordance with filters 🤔 Let me think about it a bit more.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

featureNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

    Development

    No branches or pull requests

      Participants

      @lars-reimann@pawamoy

      Issue actions

        feature: Filter shown base classes · Issue #161 · mkdocstrings/python