Skip to content

fix: Avoid recursion if a class has a reference to itself. #76

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

Merged
merged 1 commit into from
Nov 28, 2020

Conversation

matthewwardrop
Copy link
Contributor

I was attempting to use mkdocstrings with some Python library I maintain, only to find it failed because one of the classes referred to itself in one of its members. I'm not sure if this fix is ideal (since it omits the member entirely rather than including it but making it clear that there is a self-reference involved; and it doesn't deal with with non-local recursion).

What are your thoughts?

@pawamoy
Copy link
Member

pawamoy commented Nov 28, 2020

I think this fix is good enough for now. It's getting harder and harder to get the logic right. I must work on a refactor that takes all this cases into account, or at least make it easy to fix things like this when they hit.

@pawamoy pawamoy merged commit c92a791 into mkdocstrings:master Nov 28, 2020
@matthewwardrop
Copy link
Contributor Author

Thanks @pawamoy ! And yeah, these projects often have a way of outgrowing themselves... But great work so far!

@pawamoy
Copy link
Member

pawamoy commented Nov 28, 2020

You put my mind at ease a bit, thank you so much 😅

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