Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add exclude_inherited option #96

Merged

Conversation

GMartigny
Copy link
Contributor

@GMartigny GMartigny commented Feb 10, 2022

Pull Request Template

Description

Add an option to excludes inherited symbols.

When you have a lot of classes with inheritance, the last child will inherit from all its ancestor. Potentially having a lot of methods polluting the documentation.

Sometimes, it could be better to display all available methods, but in my case it created too much noise. That's why I left it under an option. If users don't set this option to true, then the current behavior is used.

Type of change

Please mark options that is/are relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Other (if so, then explain below briefly)

@ankitskvmdam
Copy link
Owner

Thanks, @GMartigny for this PR! It is really a nice feature to have.

@ankitskvmdam ankitskvmdam merged commit 3fa6e74 into ankitskvmdam:master Feb 10, 2022
This was referenced Jun 13, 2022
@GMartigny GMartigny deleted the addExcludeInheritedOption branch September 12, 2023 14:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants