Sphinx：记录与参数相同的属性

Question

我想用numpy样式的文档字符串来记录类似这样的内容。

​​

属性和参数是相同的。我可以/应该避免重复吗？

Answer 1

对于像你这样的情况，输入参数和属性完全相同的引用，我只会记录该属性。任何熟悉Python的人都会立即知道参数是。

对于更复杂的情况，我更喜欢记录类本身和__init__方法。在这种情况下，参数描述将进入__init__的文档字符串。

由于您似乎在使用autodoc扩展名，因此您需要在autoclass指令中添加:special-members: __init__选项。如果您想记录其他特殊成员，则可以将它们添加到选项的参数列表中。您也可以完全忽略参数:special-members:以记录所有魔法属性，但可能包含您不想要的内容，如__weakref__。