Python 字面意义上的「*&引用;在重组文本中
我正在看这段代码:Python 字面意义上的「*&引用;在重组文本中,python,python-sphinx,restructuredtext,Python,Python Sphinx,Restructuredtext,我正在看这段代码: def ook(*args): """Some silly function. :param *args: Optional arguments. """ ... 当我运行Sphinx时,我得到了非常有用的错误: WARNING: Inline literal start-string without end-string. 因此,我尝试了param``*`args,param:literal:'*'args,但仍然得到了警告 如何在St
def ook(*args):
"""Some silly function.
:param *args: Optional arguments.
"""
...
当我运行Sphinx时,我得到了非常有用的错误:
WARNING: Inline literal start-string without end-string.
因此,我尝试了param``*`args
,param:literal:'*'args
,但仍然得到了警告
如何在StructuredText中使用文字'*'?您可以使用(有点难看的)反斜杠引号:\*
编辑:作为(有点难看的)附录,如果您担心pylint关于反斜杠的警告,可以在字符串文本中添加r
:r”““…docstring…”
。这是在书中描述的
不同的文本处理系统配合使用有时会破坏美观。在重构文本中,您可以使用。。代码::python指令 这允许您创建python代码的文本块,而不使用任何难看的“\”字符 看起来是这样的:
.. code:: python
def ook(*args):
"""Some silly function.
:param *args: Optional arguments.
"""
...
使用函数的示例如下:
你的缩进实际上不是那样的?@Padraickenningham:不,当然不是^_~在这种情况下,我不会在param定义中包含星号-它不是代码文档中用于的参数名称的一部分,因此我希望文档字符串中包含“*”字符,而不是显示整个函数/方法。该链接是死的,只是希望添加引号也会出现这种情况,如
“a”注释“
,也可以用反斜杠固定,如“注释”
”。