python - RestructuredText 中的文字 "*"

Question

我正在查看这段代码:

def ook(*args):
    """Some silly function.

    :param *args: Optional arguments.
    """
    ...

一旦我运行 Sphinx，我就会得到非常有用的错误:

WARNING: Inline literal start-string without end-string.

因此，我尝试了 param ``*``args、param :literal:'*' args，但仍然收到警告。

如何在 restructuredText 中使用文字“*”？

Answer 1

您可以使用(有点难看的)反斜杠引号:\*

编辑:作为(有点丑陋的)附录，如果您担心有关反斜杠的 pylint 警告，您可以将 r 添加到字符串文字:r""".. . 文档字符串 ... """。这在 this pylint issue 中进行了描述.

让不同的文本处理系统很好地协同工作有时会破坏美感。