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

feature: Add option to filter out imported objects (true by default for backward compatibility) #170

Open
pawamoy opened this issue Jun 18, 2024 · 1 comment
Assignees
Labels
feature New feature or request fund Issue priority can be boosted

Comments

@pawamoy
Copy link
Member

pawamoy commented Jun 18, 2024

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

Not really, it's rather a refactoring issue. Currently the templates use filter_objects first, then do a second pass with {% if members_list is not none or attribute.is_public %}. The next version will use Griffe 0.47's is_imported (negated) instead, but that makes it hard to follow. We should move this logic into the filter_objects filter, with a config option like show_imported_objects or similar name.

Describe the solution you'd like

New config option passed to filter_objects to decide whether to filter out imported objects or not.

Describe alternatives you've considered

/

Additional context

mkdocstrings/griffe#294

Boost priority

  • Boost priority in our backlog through Polar.sh. Higher pledge, higher priority.
  • Minimum pledge by user/organization is $5, minimum amount for boost is $30.
  • View all issues with pledges.
  • We receive the funds once the issue is completed and confirmed by you.
  • Features with the insiders label are released to sponsors first, and tied to a funding goal.
Fund with Polar
@pawamoy pawamoy added the feature New feature or request label Jun 18, 2024
@pawamoy pawamoy self-assigned this Jun 18, 2024
@pawamoy pawamoy added the fund Issue priority can be boosted label Oct 22, 2024
@pawamoy
Copy link
Member Author

pawamoy commented Dec 21, 2024

Related to #78. I believe both issues could be handled at once.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request fund Issue priority can be boosted
Projects
None yet
Development

No branches or pull requests

1 participant