如何使用NumpyDoc正确地记录属性

Question

我正在管理一个使用NumpyDoc样式的包，并试图正确地记录一些属性的setters/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只适用于设置者，而Returns只适用于getter，这一点并不明显(至少对我来说)。

是否有一种标准的方法可以很好地处理NumpyDoc以及各种文档解析器(例如狮身人面像)？

Answer 1

下面的napoleon 示例表示“标准”方法是在getter方法中记录getter、setter和deleter，这表明您的方法是正确的。