python - 狮身人面像文档 : how to reference a Python property?

Question

如何引用一个用@property装饰的方法？

对于简单的方法，:py:meth: 工作正常，但对于属性则不然:它不会创建到它们的链接。

Answer 1

您应该改用 :py:attr:。这个例子对我来说很好用:

class SomeClass(object):
    """This is the docstring of SomeClass."""

    @property
    def some_property(self):
        """This is the docstring of some_property"""
        return None

    def some_method(self):
        """This is the docstring of some_method.

        And this is a reference to :py:attr:`~some_property`
        """