如何使用NumpyDoc正确记录属性

Question

我正在管理一个使用NumpyDoc风格的软件包，并且我正在尝试正确记录某些属性的setter / getter。

特别是，我遇到的问题是python忽略了setter的文档，因此所有文档都必须进入getter。另一方面，同时拥有Returns和Parameters字段似乎不太直观。例如，可以像这样编写文档

class MyVector:
    @properly
    def real(self):
        """Real part of the vector.

        Parameters
        ----------
        newreal : array-like
            New values to assign to the vector

        Returns
        -------
        real : MyVector
            Real part of the vector
        """
        pass

    @real.setter
    def real(self, newreal):
        pass

但是这样做会使Parameters和/或Returns适用的时间和方式变得非常混乱。例如。 （至少对我来说）Parameters仅适用于setter并不明显，而Returns仅适用于getter。

有没有一种标准的方法可以很好地使用NumpyDoc和各种doc解析器（例如Sphinx）？

Answer 1

以下napoleon example表示“标准”方式是记录{{1}中的getter，setter和deleter }方法，表示您的操作方式正确。