docstring

21गर्मी

3उत्तर

मैंने देखा है कि क्लोजर मल्टीलाइन डॉकस्ट्रिंग को ज्यादातर मामलों में मैन्युअल रूप से स्वरूपित किया जाता है, जिसमें clojure.core में शामिल हैं। https://github.com/clojure/clojure/blob/master/src/clj/cl

9गर्मी

3उत्तर

epydoc के docstring स्वरूपण से sphinx docstring स्वरूपण में स्विच करने के लिए स्वचालित तरीका?

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

10गर्मी

1उत्तर

पाइथन डॉकस्ट्रिंग

में पैरामीटर का संदर्भ देना मैं यह सुनिश्चित करने के लिए स्फिंक्स और ऑटोडॉक्स सुविधा का उपयोग करता हूं कि हमारे पास हमारे प्रोजेक्ट में अच्छे दस्तावेज़ हैं। तो मैं info field lists से परिचित हूं और मै

8गर्मी

2उत्तर

डॉकस्ट्रिंग्स - एक पंक्ति बनाम एकाधिक रेखा

मैं कुछ पैकेज (epydoc) दस्तावेज को मेरे द्वारा लिखे गए पैकेज में जोड़ रहा हूं, और मैं कई उदाहरणों में आ रहा हूं जहां मैं खुद को कई बार दोहरा रहा हूं। def script_running(self, script): """Return i

6गर्मी

2उत्तर

क्या सामान्य पीईपी 8 मानक के लिए अधिकतम लाइन-लंबाई अलग-अलग है?

तो मैं कुछ कोड देख रहा हूं और इसे पिलिंट की मदद से पीईपी 8 मानक तक ला रहा हूं और मैंने देखा कि अगर मैं प्रिंट स्टेटमेंट के लिए ट्रिपल कोट्स का उपयोग कर रहा था, जहां पाठ 120 वर्णों से पहले चला गया था (

22गर्मी

2उत्तर

लाइब्रेरीज़/नेमस्पेस के लिए क्लोजर प्रलेखन

संपूर्ण रूप से क्लोजर libaries/नेमस्पेस को डॉकस्ट्रिंग और/या टिप्पणियां कैसे जोड़ें, यानी नामस्थान के भीतर केवल विशिष्ट कार्यों के लिए नहीं? मैंने देखा है कि क्लोजर स्रोत कुछ स्थानों पर (comment ...)

9गर्मी

1उत्तर

ट्विस्ट के डॉकस्ट्रिंग में इन प्रारूपों का क्या अर्थ है?

ट्विस्ट के स्रोत कोड में, कई दस्तावेज़ों में इस तरह के प्रारूप होते हैं: एल {xxx} या सी {xxx} या एक पंक्ति '@' से शुरू होती है, उनका क्या अर्थ है? उदाहरण के लिए , मुड़/इंटरनेट/interfaces.py में: def r

9गर्मी

1उत्तर

पायथन सी एक्सटेंशन

में __init__ के लिए डॉकस्ट्रिंग निर्दिष्ट करने के लिए कैसे करें शायद एक बेवकूफ प्रश्न: सी एक्सटेंशन लिखते समय __init__ जैसे विशेष कार्यों के लिए डॉकस्ट्रिंग निर्दिष्ट कैसे कर सकता है? सामान्य तरीकों क

47गर्मी

7उत्तर

क्या Python दस्तावेज़ीकरण के लिए reStructuredText के लिए कोई वास्तविक विकल्प हैं?

मैं जल्द ही एक ओपन सोर्स पायथन परियोजना शुरू कर रहा हूं और मैं पहले से तय करने की कोशिश कर रहा हूं कि मेरे डॉकस्ट्रिंग कैसे लिखें। स्पष्ट उत्तर ऑटोडोक के साथ पुनर्नवीनीकरण टेक्स्ट और स्फिंक्स का उपयोग

29गर्मी

3उत्तर

मैं स्फिंक्स मार्कअप का उपयोग करके किसी दस्तावेज़ वाले पायथन फ़ंक्शन पैरामीटर का संदर्भ कैसे दूं?

मैं एक पायथन डॉकस्ट्रिंग में कहीं और पहले दस्तावेज़ वाले फ़ंक्शन पैरामीटर का संदर्भ देना चाहता हूं। def foo(bar): """Perform foo action :param bar: The bar parameter """ def neste