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

autodoc does not pick up cached_property docstring #13138

Open
LecrisUT opened this issue Nov 16, 2024 · 0 comments
Open

autodoc does not pick up cached_property docstring #13138

LecrisUT opened this issue Nov 16, 2024 · 0 comments
Labels

Comments

@LecrisUT
Copy link

Describe the bug

While the annotations of the cached_property are picked up correctly, the docstring part does not seem to be included

How to Reproduce

import functools

class Foo:
    @functools.cached_property
    def prop(self) -> int:
        """This is documented"""
        return 1

Environment Information

Platform:              linux; (Linux-6.11.7-300.fc41.x86_64-x86_64-with-glibc2.40)
Python version:        3.13.0 (main, Oct  8 2024, 00:00:00) [GCC 14.2.1 20240912 (Red Hat 14.2.1-3)])
Python implementation: CPython
Sphinx version:        8.1.3
Docutils version:      0.21.2
Jinja2 version:        3.1.4
Pygments version:      2.18.0

Sphinx extensions

extensions = [
    "myst_parser",
    "sphinx.ext.intersphinx",
    "sphinx_tippy",
    "sphinx.ext.autodoc",
    "sphinx_autodoc_typehints",
]

Additional context

No response

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant