29
मैं एक पायथन डॉकस्ट्रिंग में कहीं और पहले दस्तावेज़ वाले फ़ंक्शन पैरामीटर का संदर्भ देना चाहता हूं।मैं स्फिंक्स मार्कअप का उपयोग करके किसी दस्तावेज़ वाले पायथन फ़ंक्शन पैरामीटर का संदर्भ कैसे दूं?
def foo(bar):
"""Perform foo action
:param bar: The bar parameter
"""
def nested():
"""Some nested function that depends on enclosing scope's bar parameter.
I'd like to reference function foo's bar parameter here
with a link, is that possible?"""
return bar * bar
# ...
return nested()
वहाँ स्फिंक्स मार्कअप का उपयोग कर एक पैरामीटर संदर्भ एम्बेड करने के लिए एक आसान तरीका है, या यह स्वतः ही होगा: निम्नलिखित (वैसे पूरी तरह से कृत्रिम) उदाहरण पर विचार करें?
(मैं एक पूरी स्फिंक्स नौसिखिया। मैं स्फिंक्स डॉक्स स्कैनिंग किया गया है और इस प्रश्न का उत्तर नहीं मिला है, या एक उदाहरण उचित मार्कअप का प्रदर्शन कर रहा हूँ।)
यह बहुत अच्छा है, लेकिन गुगली डॉकस्ट्रिंग्स (जैसे 'sphinxcontrib.napoleon' के साथ उपयोग किए जाने वाले) के साथ काम नहीं करता है। क्या ऐसा कुछ है जो काम करने के लिए किया जा सकता है? – orome
इस पर निर्भर करता है कि यह कैसे काम करता है। यदि यह सीधे पुनर्गठित पाठ पर पैरा को फिर से लिखता है, तो स्फिंक्स-पैरालिंक्स में वास्तव में बॉक्स के बाहर पेश करने के लिए बहुत कुछ नहीं होगा, क्योंकि यह स्फिंक्स को नियंत्रित करने से पहले कच्चे आरएसटी को पार्स करने पर निर्भर करता है। स्फिंक्स के आंतरिक भाग में हेरफेर करने से बचने के लिए यह काफी हद तक है। यह बहुत अधिक ** बेहतर होगा यदि स्पिंक्स ने इस बिंदु पर मूल रूप से इस सुविधा को लागू किया है। मुझे उम्मीद है कि मेरा विस्तार यह स्पष्ट करता है कि इस सुविधा की कितनी जरुरत है। – zzzeek
धन्यवाद। मुझे ऐसा कुछ उम्मीद थी (यह समझ में आता है)। और मैं आपसे सहमत हूं कि यह एक बेहद जरूरी विशेषता है। – orome