स्फिंक्स

Question

का उपयोग करके अपवाद को कैसे दस्तावेज़ित करें, मुझे लगता है कि स्फिंक्स का उपयोग करके अपवादों को दस्तावेज़ित करने का तरीका नहीं पता लग रहा है। ", अप्रत्याशित अनइंडेंट फील्ड सूची एक रिक्त पंक्ति के बिना समाप्त होता है।"

def some_funct(): 
    """ 
    :raises: ExceptionType: Some multi-line 
     exception description. 
    """ 


def some_funct(): 
    """ 
    :raises: ExceptionType, Some multi-line 
     exception description. 
    """ 


def some_funct(): 
    """ 
    :raises ExceptionType: Some multi-line 
     exception description. 
    """ 


def some_funct(): 
    """ 
    :raises: 
     ExceptionType: Some multi-line 
      exception description. 
    """ 

स्फिंक्स कह रहता है:

मैं निम्नलिखित की कोशिश की है तो मैं संदेश से कैसे छुटकारा पा सकता हूं और बहु-लाइन दस्तावेज़ीकरण के साथ संभावित रूप से एकाधिक अपवादों को दस्तावेज करने का उचित तरीका क्या है?

Answer 1

आप लाइन जारी रखने के लिए बैकस्लैश का उपयोग करने से पहले: भागने के बजाय

Indenting काम करने के लिए लगता है:

def some_funct(): 
    """ 
    :raises ExceptionType: Some multi-line \ 
     exception description. 
    """ 

अद्यतन नई लाइन:

def some_funct(): 
    """ 
    :raises ExceptionType: Some multi-line 
     exception description. 
    """ 

Answer 2

यह मुझे कुछ अच्छा देता है।

आप : भूल अपवाद नाम

def some_funct(): 
    """ 
    :raise: 
     :IOException: a probleme occured 
         and it can't be passed 
    """ 

Answer 3

def some_funct(): 
    """ 
    My documentation, but watch the empty line below (necessary) 

     :raise: Exception 

      when status != my_status 
      | status <= max_status 

नोट: https://pythonhosted.org/an_example_pypi_project/sphinx.html#full-code-example कुछ अच्छा नमूने