把docstrings放在特殊的方法上？

Question

我想要决定放在类文档字符串中的什么信息以及要放在__init__方法文档字符串中的内容。到目前为止，我一直在概述类，以及如何在类docstring中使用它，而与初始化（参数详细信息等）直接相关的东西，我放在__init__文档字符串中。

今天我开始想知道这是否是正确的做法，所以我查看了几个内置模块，我发现__init__方法几乎从不具有文档字符串。根据PEP8，“Docstrings不是非公开方法必需的”，但不是__init__公开？

以同样的方式，其他特殊方法如__getitem__，__getattr__或__new__，他们应该有文档吗？或者我应该只提到他们在班级文档字符串中的后果？

Answer 1

直接从PEP 257：

公共方法（包括__init__构造）也应该有文档字符串。

[...]

类构造函数应该在文档字符串来证明其__init__方法。