__init__
クラスdocstringに入れる情報と、メソッドdocstringに入れる情報を決定しようとしています。これまで、クラスの概要とその操作方法をクラスdocstringに入れてきましたが、初期化に直接関連するもの(引数の詳細など)は__init__
docstringに入れました。
今日、これが正しい方法かどうか疑問に思い始めたので、いくつかの組み込みモジュールを調べましたが、この__init__
メソッドにdocstringが含まれることはほとんどありません。PEP8によると、「非公開メソッドにはDocstringは必要ありません」が、 公開されていません__init__
か?
__getitem__
同じように、、、、__getattr__
などの他の特別なメソッドについては、__new__
docstringを使用する必要がありますか?それとも、それらがクラスdocstringに与える影響について言及する必要がありますか?