Question

关于numpydoc docstring约定的问题：

我有一个类，它包含许多不返回任何内容的方法，但是为类添加了一个属性。例如：

class MyClass(object):
    def __init__(self, a, b):
         self.a = a
         self.b = b
         return

    def a_mult(self, mult):
        """
        Multiplies `a` by `mult`.

        Parameters
        ----------
        mult : float
            Value to multiply `a` by.

        Returns
        -------
        None
        """
        self.product = a * mult
        return

在这个笨拙的例子中，MyClass.a_mult没有返回任何内容，但会向MyClass添加一个属性。

我已根据numpydoc样式指南添加了MyClass.a_mult的文档字符串。 docstring声明该方法返回None，但我无法看到记录MyClass.a_mult方法如何修改MyClass实例的标准方法。

提前感谢您的帮助！

Answer 1

根据@mgilson和@ user2357112的有用建议，我意识到我的课程设计很差。我已经改变了所以数据分析的所有阶段都存储在一个字典中。分析函数现在向dict添加元素，而不是向类实例添加新属性。

感谢指点。

numpydoc convention：方法修改类但不返回任何内容

1 个答案: