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

Always cast the special_members as a list #9472

Closed
wants to merge 1 commit into from

Conversation

miohtama
Copy link

This is a potential fix for

#9471

#9436

Autodoc is mixing set and list types for the same self.options.special_members variable.

However because the original code is not typed, it is hard to deduct from the context if the fix is "correct" or "clean". I suggest some of the original authors review the fix.

It is unclear from the context if `special_members` should be a list or a set - just go with the list
@RuRo
Copy link
Contributor

RuRo commented Jul 24, 2021

@tk0miya I can no longer leave comments on #4257 for some reason (not sure, why did GitHub even allow me to open that code review in the first place 😅). Also, I didn't notice that somebody already reported this issue, when I was writing that comment, sorry for the confusion. Not sure, if the special_members was supposed to be a set or a list originally, but this PR seems to fix the issue.

@tk0miya
Copy link
Member

tk0miya commented Jul 24, 2021

Oops... list should be used for this case. So set is invalid.

@tk0miya
Copy link
Member

tk0miya commented Jul 25, 2021

Merged #9493 instead.
Thank you for your contribution!

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

Successfully merging this pull request may close these issues.

None yet

3 participants