Skip to content

Treat methods decorated with functools.cached_property as properties #436

Closed
@michellewang

Description

@michellewang

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    BugGood First IssueGood issue for first time contributors

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions