पेप 8 को संतुष्ट करने के लिए मैं आरएसटी डॉकस्ट्रिंग में एक लिंक कैसे तोड़ूं?

Question

मैं एपीआई दस्तावेज उत्पन्न करने के लिए स्फिंक्सडोक का उपयोग कर रहा हूं, और मैंने डॉकस्ट्रिंग लिखते समय पेप 8 अनुरूपता के साथ एक समस्या में भाग लिया है।

आप नीचे देख सकते हैं, OWASP साइट का लिंक अतीत क्या pep8 तय maximum-line-length

def handle_csrf(...): 
    """The general recommendation by people in the know [OWASP]_, is 
     'to implement the Synchronizer Token Pattern (STP_)'. 

     .. [OWASP] The Open Web Application Security Project 
      (https://www.owasp.org/index.php/Cross-Site_Request_Forgery_(CSRF)_Prevention_Cheat_Sheet) 
     .. _STP: http://www.corej2eepatterns.com/Design/PresoDesign.htm 

    """ 

स्तंभ 105 पर समाप्त होता है, अभी तक वहाँ यूआरएल रैप करने के लिए एक रास्ता है, जबकि अभी भी उस में एक यूआरएल रखते हुए उत्पन्न दस्तावेज़?

बैकस्लैश डालने से काम नहीं हुआ।

Answer 1

बैकस्लैश \ नौकरी करता है, लेकिन सुंदर इंडेंटेशन को गड़बड़ कर देता है।

def handle_csrf(): 
    """The general recommendation by people in the know [OWASP]_, is 
     'to implement the Synchronizer Token Pattern (STP_)'. 

     .. [OWASP] The Open Web Application Security Project 
      (https://www.owasp.org/index.php/Cross-\ 
Site_Request_Forgery_(CSRF)_Prevention_Cheat_Sheet) 
     .. _STP: http://www.corej2eepatterns.com/Design/PresoDesign.htm 

    """ 

परिणाम (समान लंबी लाइन के लिए है): - यह एक (दुर्लभ) इस मामले में जहां यह अनदेखी करने के लिए ठीक है लगता है

>>> print handle_csrf.__doc__ 
The general recommendation by people in the know [OWASP]_, is 
     'to implement the Synchronizer Token Pattern (STP_)'. 

     .. [OWASP] The Open Web Application Security Project 
      (https://www.owasp.org/index.php/Cross-Site_Request_Forgery_(CSRF)_Prevention_Cheat_Sheet) 
     .. _STP: http://www.corej2eepatterns.com/Design/PresoDesign.htm 

इसके अलावा, PEP8 एक गाइड, नहीं एक कानून है ।

Answer 2

a problem में देख रहे हैं, मैं समाधान के आसपास एक (एन सुरुचिपूर्ण?) काम के साथ आया था।

सबसे पहले, यहाँ मेरी docstring है:

.. autofunction:: ook 
.. _SQLAlchemy: http://www.sqlalchemy.org 

तो जब ook प्रलेखित है, SQLAlchemy _ लिंक काम करता है:

def ook(): 
"""The sound a monkey makes... 
    ⚠ `SQLAlchemy`_ used here. 
""" 
... 

दूसरा, पहला फ़ाइल में, मैं इस परिभाषित किया गया है।