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

Better autodoc skip member #2076

Closed
wants to merge 3 commits into from

Conversation

JelteF
Copy link
Contributor

@JelteF JelteF commented Oct 9, 2015

Make autodoc skip-member callback more powerful in two ways:

  1. Add the possibility to override members in exclude-members
  2. Pass the namespace, to make it possible to do different things for different classes.

The last one would probably count as a breaking change, since the function needs to accept a new argument.

@JelteF
Copy link
Contributor Author

JelteF commented Aug 28, 2016

Any update on responding to this?

@tk0miya tk0miya added this to the 2.0.0 milestone Sep 5, 2018
@tk0miya tk0miya removed this from the 2.0.0 milestone Sep 5, 2018
@tk0miya tk0miya added the type:proposal a feature suggestion label Jul 12, 2020
@tk0miya tk0miya added this to the 3.2.0 milestone Jul 12, 2020
@tk0miya
Copy link
Member

tk0miya commented Jul 12, 2020

Add the possibility to override members in exclude-members

+1: Reasonable. I'd like to cherry-pick this change into next stable release.

Pass the namespace, to make it possible to do different things for different classes.

-1: I can understand your idea. Indeed, it would be useful. But I can't accept this because for a breaking change. It's difficult to migrate user's hooks to the new argument.

@tk0miya
Copy link
Member

tk0miya commented Jul 15, 2020

merged the former one (see #7954).
Thank you for your contribution!

@tk0miya tk0miya closed this Jul 15, 2020
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 26, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants