RestructuredText 中的文字“*”答案

【问题标题】：A literal "*" in RestructuredTextRestructuredText 中的文字“*”
【发布时间】：2015-08-07 21:23:28
【问题描述】：

我在看这个sn-p的代码：

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 中有一个文字“*”？

【问题讨论】：

【解决方案1】：

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

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

看起来像这样：

.. code:: python

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

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

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

【讨论】：

【解决方案2】：

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

编辑：作为一个（有点难看的）附录，如果您担心 pylint 关于反斜杠的警告，您可以在字符串文字中添加 r：r""" ... docstring ... """。这是在this pylint issue 中描述的。

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

【讨论】：