numpydoc约定:方法修改类，但什么也不返回

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添加了一个属性。

我按照MyClass.a_mult样式指南为农比多提供了一个docstring。docstring声明该方法不返回任何内容，但我看不到记录MyClass.a_mult方法如何修改MyClass实例的标准方法。

提前感谢您的帮助！

Answer 1

遵循“mgilson”和“were 2357112”的有益建议，我意识到我的课程设计很差。我已经改变了数据分析的所有阶段都存储在一个数据块中。分析函数现在向dict添加元素，而不是向类实例添加新属性。

谢谢你的指点。