Crash when encountering class attributes that are aliases

Chilipp / autodocsumm

Extending your autodoc API docs with a summary

Apache License 2.0

48 stars 14 forks source link

Crash when encountering class attributes that are aliases #44

Closed IljaManakov closed 3 years ago

IljaManakov commented 3 years ago

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 commented 3 years ago

Fixed by #42

Chilipp commented 3 years ago

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