2015-05-26 5 views
8

में मैं कोड के इस स्निपेट से देख रहा हूँ:एक शाब्दिक "*" RestructuredText

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

:

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

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

और जैसे ही मैं स्फिंक्स चलाने के रूप में, मैं ओह-इतनी उपयोगी त्रुटि मिलती है इसलिए, मैंने param ``*``args, param :literal:'*' args को आजमाया और अभी भी चेतावनी प्राप्त की।

मैं कैसे restructuredText में '*' एक शाब्दिक है?

+1

अपने खरोज वास्तव में उस तरह नहीं है? –

+1

@ पैड्राइक कनिंघम: नहीं, ज़ाहिर है यह नहीं है।^_ ~ – Sardathrion

उत्तर

10

आप (कुछ बदसूरत) बैकस्लैश उद्धरण इस्तेमाल कर सकते हैं: \*

संपादित करें: एक (कुछ बदसूरत) परिशिष्ट के रूप में, यदि आप pylint बैकस्लैश के बारे में चेतावनी बारे में चिंतित हैं, तो आप एक r स्ट्रिंग के लिए जोड़ सकते हैं शाब्दिक: r""" ... docstring ... """। यह this pylint issue में descibed था।

होने भिन्न पाठ प्रोसेसिंग सिस्टम एक साथ अच्छी तरह से खेलते हैं कभी कभी सौंदर्यशास्त्र नष्ट कर देता है।

+0

जवाब अद्यतन, मेरे संपादन – knitti

-1

restructuredtext में आप .. कोड :: अजगर के निर्देश का उपयोग कर सकते हैं।

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

यह वर्ण आप किसी भी बदसूरत बिना अजगर कोड का एक शाब्दिक ब्लॉक बनाने की अनुमति देता '\'।

यह इस तरह दिखता है:

.. code:: python 

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

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

अपने समारोह का उपयोग कर एक उदाहरण यहाँ है:

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

+0

यह इन-कोड प्रलेखन के लिए है देखते हैं, तो मैं "*" डॉक स्ट्रिंग में चरित्र, न कि पूरी समारोह/विधि दिखाने चाहते हैं। – Sardathrion

संबंधित मुद्दे