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

Treat methods decorated with functools.cached_property as properties #436

Closed
michellewang opened this issue Apr 12, 2024 · 0 comments
Closed
Labels
Bug Good First Issue Good issue for first time contributors

Comments

@michellewang
Copy link

Thank you for this great project!

I notice that methods decorated with functools.cached_property (introduced in Python 3.8) render as generic methods, while those decorated with property are handled differently (leading property keyword, no round brackets):
Screenshot 2024-04-11 at 9 30 44 PM

This is misleading since cached properties are not supposed to be called like normal methods. Would it be possible to make it so that cached properties are rendered in the same way as properties? It looks like sphinx.ext.autodoc has been updated to do this.

@AWhetter AWhetter added Bug Good First Issue Good issue for first time contributors labels Apr 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Good First Issue Good issue for first time contributors
Projects
None yet
Development

No branches or pull requests

2 participants