python - クラス内のメソッドの一部のドキュメント文字列がpydocに表示されないのはなぜですか?

Question

私はpydocドキュメントを作成するために使用しています。docstringただし、クラスと などのメソッドののみを表示してい__init__ます。クラスの各メソッドpydocのドキュメントを作成するために渡されるパラメーターはありますか?

例：

class myclass(some_other_class):
    """
    This is 'class' docstring.
    """

    def __init__(self):
       """
       This is docsctring for __init__ method.
       """
       pass

    def mymethod(self, some_parameter):
       """
       This is docstring for mymethod function.
       """
       pass

このコードで pydoc を使用すると、「This is docstring for mymethod function.」というメッセージが表示されません。生成された出力で。

Answer 1

あなたのコードは完全に問題ないように見えます。私はそれをscript.pyファイルに入れ、「some_other_class」参照を削除して、python -m pydoc -w script. 次の HTML が生成されました。

class myclass
      This is 'class' docstring.

      Methods defined here:
          __init__(self)
            This is docsctring for __init__ method.
          mymethod(self, some_parameter)
            This is docstring for mymethod function.