numpydoc 约定：方法修改 class 但 returns 什么都没有

Question

关于 numpydoc 文档字符串约定的问题：

我有一个class，其中包含一些return没有的方法，只是向class添加了一个属性。例如：

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 没有 return 任何东西，而是向 MyClass 添加了一个属性。

我按照 numpydoc 风格指南包含了 MyClass.a_mult 的文档字符串。文档字符串指出方法 returns None，但我看不到记录 MyClass.a_mult 方法如何修改 MyClass 实例的标准方法。

在此先感谢您的帮助！

Answer 1

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

感谢指点

numpydoc 约定：方法修改 class 但 returns 什么都没有

numpydoc conventions: method modifies class but returns nothing

python

numpy

docstring

numpydoc