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""" ... docstring ... """.这是在这个pylint问题中被描述的.

让不同的文本处理系统很好地共同破坏有时会破坏美学.

只是想补充一点，这也会发生在引号中，如`""" a "comment """`，也可以用反斜杠修复，如`""" a \"comment\" """"` 。 (2认同)