RestructuredText中的字面"*“

Question

我正在看这段代码：

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

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

一旦我运行狮身人面像，我就会得到一个非常有用的错误：

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

所以，我尝试了param ``*``args，param :literal:'*' args，仍然收到了警告。

我如何在restructuredText中有一个字面上的“*”？

Answer 1

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

编辑:作为一个(有点难看的)增编，如果您关注关于反斜杠的pylint警告，可以在字符串r：r""" ... docstring ... """中添加一个the。这是在这个庞然大物进行的。

不同的文本处理系统在一起发挥的很好，有时会破坏美学。

Answer 2

在重组文本中，您可以使用.。代码：：python指令。

http://docutils.sourceforge.net/docs/ref/rst/directives.html#code

这使您可以创建一个文字块的python代码，而不需要任何丑陋的“\”字符。

看起来是这样的：

.. code:: python

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

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

下面是使用您的函数的一个示例：

http://rst.ninjs.org/?n=c8ad07eaea190745755a6d80d37786e6&theme=basic