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

Crash when encountering class attributes that are aliases #44

Closed
IljaManakov opened this issue Mar 29, 2021 · 2 comments
Closed

Crash when encountering class attributes that are aliases #44

IljaManakov opened this issue Mar 29, 2021 · 2 comments

Comments

@IljaManakov
Copy link

Hi,

I have encountered an issue where autodocsumm crashes when it encounters a class attribute that is a type instance (i.e. it is just an alias). What appears to happen is the following:

  • autodoc's ClassCodumenter's get_doc returns None for aliases.
  • AutoSummary's get_grouped_documenters attempts to iterate over the return value of get_doc
  • Combined, this results in a TypeError when a class has a type instance as an attribute

minimal-example.zip

@EpicWink
Copy link
Contributor

Fixed by #42

@Chilipp
Copy link
Owner

Chilipp commented Apr 15, 2021

Thanks for reporting @IljaManakov! This issue has been closed via #42.

@Chilipp Chilipp closed this as completed Apr 15, 2021
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

No branches or pull requests

3 participants