Pythonのdoc文字列では、-sを引数リストに揃えるのが普通ですか？たとえば

Question

：私は「幅」の後に余分なスペースが追加されているか

def foo(length, width): 
    """Short desc. 

    Arguments: 

    length -- A desc. 
    width -- A desc. 
    """ 

注意。

Answer 1

これについての慣習はないと思います。関数のドキュメンテーション文字列が

ことができる上、その動作を要約し、その引数、戻り値（s）は、副作用、発生した例外、および制限を文書化する必要がある関数やメソッドのdocstringですに関するすべてのPEP 257氏は述べています（該当する場合はすべて）呼び出されます。オプションの引数を指定する必要があります。キーワード引数がインタフェースの一部であるかどうかを文書化する必要があります。

PEPに与えられた唯一の例でも問題に光を当てていません：

def complex(real=0.0, imag=0.0): 
    """Form a complex number. 

    Keyword arguments: 
    real -- the real part (default 0.0) 
    imag -- the imaginary part (default 0.0) 

    """ 
    if imag == 0.0 and real == 0.0: return complex_zero 
    ... 

私は通常のダッシュを揃えるんが、私は一般的な慣習があるとは思いません。

Answer 2

私はそれが選択の問題だと思います。

多くの人々がReSTをドキュメントストリングに使用し、Sphinxを使用してドキュメントを生成します。この場合、いくつかの要件があるかもしれませんが、私はダッシュのアラインメントがその一つだとは思わない。

多くの行を再調整する必要があるものを追加するとすぐにdiffを非常に醜いものにするので、私は物事を整列させるという考え方が嫌いです。

Answer 3

私はあなたの例が気に入っています（ - を整列させて）、ドキュメントストリングを一見して読みやすくすると思います。

これはPEP 8スタイルの標準がないため、最終的には趣味の問題です。つまり、標準ライブラリにはいくつかの先例があります。たとえば、次のようにpoplib moduleのdocstringから取られる：

class POP3: 

    """This class supports both the minimal and optional command sets. 
    Arguments can be strings or integers (where appropriate) 
    (e.g.: retr(1) and retr('1') both work equally well. 

    Minimal Command Set: 
      USER name    user(name) 
      PASS string    pass_(string) 
      STAT     stat() 
      LIST [msg]    list(msg = None) 
      RETR msg    retr(msg) 
      DELE msg    dele(msg) 
      NOOP     noop() 
      RSET     rset() 
      QUIT     quit() 

    """