Un letterale "*" in reStructuredText

Question

sto guardando questo frammento di codice:

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

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

E non appena corro Sfinge, ottengo l'errore oh-così utile:

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

Quindi, ho provato param ``*``args, param :literal:'*' args e ho ancora ricevuto l'avviso.

Come si dispone di un letterale '*' in ristrutturato testo?

Answer 1

È possibile utilizzare il (un po 'brutto) backslash citazione: \*

EDIT: Come un addendum (un po' brutto), se siete preoccupati per pylint avvertimento circa il backslash, si potrebbe aggiungere un r alla stringa letterale: r""" ... docstring ... """. Questo è stato descritto in this pylint issue.

Avere sistemi di elaborazione del testo diversi che funzionano bene insieme distrugge a volte l'estetica.

Answer 2

Nel testo ristrutturato è possibile utilizzare la direttiva .. code :: python.

http://docutils.sourceforge.net/docs/ref/rst/directives.html#code

Ciò consente di creare un blocco letterale di codice Python senza alcuna brutta '\' caratteri.

Ecco come si presenta:

.. code:: python 

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

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

Un esempio di utilizzare la funzione è qui:

http://rst.ninjs.org/?n=c8ad07eaea190745755a6d80d37786e6&theme=basic