python - 在 Python 文档字符串中，是否习惯于在参数列表中对齐 -- ？

Question

例如:

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

    Arguments:

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

请注意我如何在“宽度”之后添加额外的空格。

Answer 1

我认为这是一个选择问题。

很多人实际上使用 ReST在他们的文档字符串中，然后使用 Sphinx 生成文档。在这种情况下，可能有一些要求，但我认为破折号对齐不是其中之一。

我不喜欢对齐事物的想法，因为一旦添加需要重新对齐许多行的内容，它就会使差异变得非常难看。