इस पेज पर Google Docs के सीज़न के लिए स्वीकार किए गए एक तकनीकी लेखन प्रोजेक्ट की जानकारी है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- SymPy
- तकनीकी लेखक:
- कुछ देर के लिए
- प्रोजेक्ट का नाम:
- सभी डॉकस्ट्रिंग को एक जैसा रखें
- प्रोजेक्ट की अवधि:
- मानक अवधि (तीन महीने)
प्रोजेक्ट का विवरण
इस प्रोजेक्ट के लिए, मेरी कोशिश है कि SymPy की डॉकस्ट्रिंग में एक जैसा बदलाव किया जाए.
अपने मेंटॉर के साथ काम करते हुए, मुझे सबसे पहले कोड बेस में डॉकस्ट्रिंग के लिए ज़रूरी फ़ॉर्मैट की पहचान करनी होगी. उसके बाद मैं पूरे कोडबेस में सभी docstrings का पालन करने के लिए एक दस्तावेज़ फ़ॉर्मेटिंग गाइड बना दूंगा. इस प्रोजेक्ट पर मेरे काम में मौजूदा डॉकस्ट्रिंग को अपडेट करने के लिए नई गाइड को लागू करना भी शामिल है. इसके अलावा, भाषा के इस्तेमाल या शब्दों जैसी दिक्कतों को इकट्ठा करके उन्हें ठीक भी किया जाएगा. मेरे मेंटॉर और मैं मिलकर इस बारे में संपादकीय फ़ैसले लेंगे कि इन अतिरिक्त सुविधाओं को कैसे मैनेज किया जाए. साथ ही, स्टाइल से जुड़ी प्राथमिकताओं को भी गाइड में शामिल किया जाएगा.
इस प्रोजेक्ट का आखिरी लक्ष्य, दस्तावेज़ की फ़ॉर्मैटिंग और स्टाइल गाइड होगी. इसका इस्तेमाल डेवलपर और योगदान देने वाले, दोनों कर सकते हैं. इससे, अभी और आने वाले समय में SymPy की डॉकस्ट्रिंग को एक जैसा बनाए रखने में मदद मिलेगी.