2015-05-26 69 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