複数行の記述は

Question

だから、reStructuredTextのは、あなたの関数のシグネチャのドキュメントを正規化することができます find in the sphinx documentation か、Pythonのコード ドキュメントの the recommended wayです。すべての例は 単線​​ですが、パラメータ記述が次のような複数行の場合はどうですか？ ？

def f(a, b): 
    """ Does something with a and b 

    :param a: something simple 
    :param b: well, it's not something simple, so it may require more than eighty 
       chars 
    """ 

どのような構文/規則ですか？私はインデントする必要がありますか？それはreSTructuredTextレンダリングを破るでしょうか？

Answer 1

あなたインデントに対する少なくとも1つのレベルによると、そのようだ：PARAM：ディレクティブ、それはreStructuredTextのレンダリングを中断されません。個人的には、すべての追加行をそのパラメータの最初の記述行に整列させることを好みます。 reSTは改行を無視し、改行なしでテキストを表示することに注意してください。

残念ながら、私はこの問題について言及するソースを見つけることができず、複数行：param：descriptionの例を挙げることができませんでした。

Answer 2

単純に改行して改行したい場所。

def f(a, b): 
    """ Does something with a and b 

    :param a: something simple 
    :param b: well, it's not something simple, 
       so it may require more than eighty 
       chars 
    """ 

Answer 3

はい、スフィンクスの字下げ作業には快適であると思われ、pep8は主張しません。また、あなたはPythonの伝統的なラインが\でbreakes記述はあなたが使用することができます生成ドキュメントの複数行にしたくない場合：

def f(a, b): 
    """ Does something with a and b 

    :param a: something simple 
    :param b: well, it's not something simple, so it may require more \ 
       than eighty chars 
    """