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

，但仍然收到警告。

如何在重组文本中使用文字“*”？

Answer 1

你可以使用（有点难看的）反斜杠引用：

\*

编辑：作为（有点难看的）附录，如果您担心有关反斜杠的 pylint 警告，您可以在字符串文字中添加一个

：

r""" ... docstring ... """

。这是在这个pylint问题中描述的。

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

Answer 2

在重组文本中，您可以使用 .. code:: python 指令。

这允许您创建一个没有任何难看的“\”字符的 python 代码块。

看起来像这样：

.. code:: python

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

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

这里有一个使用你的函数的例子：

Answer 3

0
投票

:param `*args`:

以上对我有用:)