documenting issues with @cached_property
Closed this issue · 2 comments
bastianh commented
Hi,
when I use @cached_property on a class function it won't get documented by sphinx autodoc.
Is there a way to fix that or a workaround ?
Thanks,
bastian
found following notice in the spinx docs:
If you document decorated functions or methods, keep in mind that autodoc retrieves its docstrings by importing the module and inspecting the doc attribute of the given function or method. That means that if a decorator replaces the decorated function with another, it must copy the original doc to the new function.
From Python 2.5, functools.wraps() can be used to create well-behaved decorating functions.
Suor commented
Thanks for pointing this out.
bastianh commented
Thanks for fixing... you have a great library ;)