2015-05-26 68 views
8

我在看这个代码片段:当我运行狮身人面像字符“*”,在新结构化

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

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

而且,我得到的哦,所谓有用的错误:

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

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

如何在restructuredText中使用文字'*'?

+1

你的缩进实际上不是这样呢? –

+1

@PadraicCunningham:不,当然不是。^_〜 – Sardathrion

回答

10

你可以使用(有点丑陋)反斜杠报价:\*

编辑:作为一个(有点丑陋)附录,如果您担心pylint的警告有关反斜杠,你可以添加一个r字符串字面意思是:r""" ... docstring ... """。这是在this pylint issue中描述的。

让不同的文本处理系统在一起玩很好,有时会破坏美学。

+0

答案已更新,请参阅我的编辑 – knitti

-1

在restructuredtext中,您可以使用.. code :: 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

+0

这是用于代码内的文档,所以我希望文档字符串中的“*”字符不显示整个函数/方法。 – Sardathrion