将docstrings放在特殊方法上？

Question

我正在尝试决定在类docstring中放入哪些信息以及在__init__方法docstring中放入什么。到目前为止，我已经在类docstring中概述了类以及如何使用它，而与初始化（参数详细信息等）直接相关的内容我放入了__init__ docstring。

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

同样，如果有其他特殊方法，例如__getitem__，__getattr__或__new__，他们应该有文档字符串吗？或者我应该只提一下他们在类docstring中的后果吗？

Answer 1

直接来自PEP 257：

  

公共方法（包括__init__构造函数）也应该有docstrings。

[...]

  

类构造函数应记录在其__init__方法的文档字符串中。