对于类和 __init__ 文档字符串中应记录的内容是否达成共识？

我没有找到任何关于课堂上应记录的内容的最佳实践，并且__init__文档字符串。有时我发现构造函数参数已经记录在类文档字符串中，有时在__init__文档字符串。我更喜欢在类文档字符串中描述构造，因为这是创建新实例时所调用的。但是应该在文件中记录什么__init__那么方法文档字符串呢？

edit:

我知道关于谷歌风格指南 https://google.github.io/styleguide/pyguide.html?showone=Comments#Comments和谷歌文档字符串样式示例 https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html，但两者都没有回答我的问题。文档字符串风格的例子确实说

The __init__方法可以记录在类级别 文档字符串，或作为文档字符串__init__方法本身。 任何一种形式都可以接受，但两者不应混合。选一个 公约记录__init__方法并与其保持一致。

但是如果我选择将文档字符串放在__init__函数到类级别文档字符串中，应该是什么__init__文档字符串包含？

官方已经给出了答案，在PEP 257 https://www.python.org/dev/peps/pep-0257/（文档字符串 PEP），可以说是权威的：

类构造函数应记录在文档字符串中__init__ method.

这是非常合乎逻辑的，因为这是函数和方法的通常过程，并且__init__()也不例外。

因此，这将代码及其文档放在同一个位置，这有助于维护。

最后，向用户显示文档的工具（例如 Jupyter 或内置的 Python shell 命令）help()）更有可能正确显示代码的文档。在实践中，他们do显示__init__()当您寻求帮助时会自动显示文档字符串class，所以这是遵循将初始化文档放入官方惯例的又一个原因__init__().