इस पेज पर Google Docs के सीज़न के लिए स्वीकार किए गए एक तकनीकी लेखन प्रोजेक्ट की जानकारी है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- SymPy
- तकनीकी लेखक:
- Soumi7
- प्रोजेक्ट का नाम:
- सभी docstrings में एक जैसा दिखना - Sympy का दस्तावेज़
- प्रोजेक्ट की अवधि:
- मानक अवधि (तीन महीने)
प्रोजेक्ट का विवरण
संक्षेप :
Sympy दस्तावेज़ और पिछले काम की मौजूदा स्थिति :
SymPy की आधिकारिक स्टाइल गाइड बनाने का काम पूरा हो गया है.
लॉरेन ग्लैटली के जीएसओडी प्रोजेक्ट ने SymPy docstrings के लिए एक स्टाइल गाइड बनाई है. इसे SymPy डॉक्यूमेंटेशन स्टाइल गाइड में देखा जा सकता है.
खास सब-मॉड्यूल और clearrs.py फ़ाइल में docstrings में बदलाव किया गया है, ताकि नई स्टाइल गाइड के दिशा-निर्देशों का लगातार पालन किया जा सके
इसके बाद भी, कोड बेस की अन्य सभी डॉकस्ट्रिंग में बदलाव किया जाना था, ताकि नई स्टाइल गाइड का पालन किया जा सके.
प्रस्तावित काम :
SymPy की ज़्यादातर डॉकस्ट्रिंग, अब भी सबसे नई स्टाइल गाइड का पालन नहीं करती हैं. इस प्रोजेक्ट का मकसद, इस गाइड का पालन करने के लिए SymPy की सभी डॉकस्ट्रिंग को अपडेट करना है.
मैंने मेंटॉर से प्रोजेक्ट के बारे में बात की. यहां चर्चा का लिंक दिया गया है.
यह फ़ैसला लिया गया कि सिंपी के कोडबेस में डॉकस्ट्रिंग में बदलाव करके, सबसे नई स्टाइल गाइड का पालन करें. यह एक बड़ा टास्क है और प्रोजेक्ट सिर्फ़ यहीं तक सीमित होना चाहिए.
इस प्रोजेक्ट पर मेरे काम में मौजूदा डॉकस्ट्रिंग को अपडेट करने के लिए नई गाइड लागू की जाएगी. साथ ही, भाषा के इस्तेमाल या शब्दों जैसी दिक्कतों को इकट्ठा करके उन्हें ठीक किया जाएगा.
मौजूदा सब-सेक्शन के क्रम को बाद में या किसी अलग टास्क के तौर पर बदला जा सकता है या उस पर फ़ैसला लिया जा सकता है.
पैरामीटर सेक्शन के साथ ज़्यादा उदाहरण जोड़कर, पैरामीटर में अलग-अलग वैल्यू पास किए जाने पर नतीजों में अंतर दिखाना.
'गेटचा' और 'गलतियां' सेक्शन में मुश्किल उदाहरण जोड़ते रहें.
योगदान: - #17887 : समस्या #17887 पर काम किया गया: खास सबमॉड्यूल में, छूटे हुए डॉकस्ट्रिंग के सेक्शन जोड़ें. मैंने स्पेशल सबमॉड्यूल के कुछ फ़ंक्शन में, पैरामीटर और उदाहरण वाले सेक्शन में वह पैरामीटर जोड़ दिया है जो मौजूद नहीं है. इन फ़ंक्शन में L की मदद से बदलाव किया गया था. नई स्टाइल गाइड का पालन करें और आने वाले समय की डॉकस्ट्रिंग के लिए एक मॉडल के तौर पर काम करें.
मेरे मर्ज किए गए पीआर का लिंक यहां दिया गया है : https://github.com/sympy/sympy/pull/19334
- #19591 : समस्या #19591 डॉक्यूमेंटेशन स्टाइल गाइड को ट्रैक करती है. नई स्टाइल गाइड का पालन करने के लिए, मैंने core.sympify docstring में बदलाव करने के लिए PR जोड़ा है. मैंने अलग-अलग पैरामीटर के इस्तेमाल के बारे में, स्ट्रक्चर्ड एक्सप्लेनेशंस और उदाहरण जोड़े हैं.
यहां पीआर का लिंक दिया गया है: https://github.com/sympy/sympy/pull/19613
प्रोजेक्ट के लक्ष्य
टाइमलाइन 17 अगस्त से पहले :
- संगठन में योगदान देना जारी रखें.
- उपयोगकर्ता दस्तावेज़ और सिंपी के मौजूदा वर्शन के बारे में ज़्यादा जानें.
- ऐसी तकनीकें और कौशल सीखें जिनसे प्रोजेक्ट को लागू करने में मदद मिलेगी.
कम्यूनिटी बॉन्डिंग : (17 अगस्त से 13 सितंबर, 2020)
- समय के अंतर की वजह से, बातचीत का चैनल और समय सेट अप करें.
- अपने लक्ष्यों को बेहतर बनाना और दोनों तरफ़ की उम्मीदें सेट करना.
- मॉड्यूल को अपडेट करने के क्रम के बारे में बातचीत.
- मॉड्यूल में बदलाव करने के क्रम को फ़ाइनल करें, ताकि उन्हें नई docstring स्टाइल गाइड का पालन किया जा सके.
दस्तावेज़ की अवधि(14 सितंबर, 2020 से 30 नवंबर, 2020) :
हर हफ़्ते हासिल करने के लिए लक्ष्य सेट करें. हो सकता है कि हर हफ़्ते या उससे ज़्यादा समय में, एक मॉड्यूल या सबमॉड्यूल की डॉकस्ट्रिंग को अपडेट करना ज़रूरी हो.
इन सभी मॉड्यूल के लिए, मेरा मुख्य लक्ष्य छूटे हुए सेक्शन को जोड़ना और सबसे नई स्टाइल गाइड का पालन करने के लिए डॉकस्ट्रिंग को फिर से तैयार करना होगा. इसमें पैरामीटर में अलग-अलग वैल्यू भेजने पर मिले अलग-अलग नतीजे दिखाना शामिल होगा. मुश्किल आउटपुट को 'गॉचा' और 'गलतियां' सेक्शन में जोड़ दिया जाएगा.
पहला हफ़्ता ( 14 सितंबर से 21 सितंबर) : मुख्य
दूसरा हफ़्ता (22 सितंबर से 29 सितंबर) : फ़ंक्शन : सबमॉड्यूल का कॉम्बिनेशन
तीसरा हफ़्ता (30 सितंबर से 6 अक्टूबर) : फ़ंक्शन
चौथा हफ़्ता (7 अक्टूबर से 14 अक्टूबर) : आसान, क्रिप्टो करंसी
पांचवां हफ़्ता (15 अक्टूबर से 21 अक्टूबर) : डायोफ़ैंटाइन
छठा हफ़्ता (22 अक्टूबर से 29 अक्टूबर):होलोनॉमिक :ऑपरेशन सबमॉड्यूल
हफ़्ता 7 (30 अक्टूबर से 7 नवंबर) : Integrals मॉड्यूल(integrals.integrals), कंप्यूटिंगर मीजर G-फ़ंक्शन का इस्तेमाल करके इंटीग्रेल की गणना करना
आठवां हफ़्ता (8 नवंबर से 15 नवंबर) : भौतिक विज्ञान, कैटगरी मॉड्यूल के आखिर में होने वाले फ़ंक्शन, कोड जनरेशन मॉड्यूल, सबमॉड्यूल
नौवां हफ़्ता (16 नवंबर से 23 नवंबर) : भौतिक विज्ञान, कैटगरी मॉड्यूल के आखिर में होने वाले फ़ंक्शन, कोड जनरेशन मॉड्यूल, सबमॉड्यूल स्पेशल
10वां हफ़्ता (24 नवंबर से 30 नवंबर) : गॉचा और पिटफ़ॉल सेक्शन
30 नवंबर से 5 दिसंबर, 2020 को शाम 18:00 बजे यूटीसी : प्रोजेक्ट सबमिट करने और रिपोर्ट लिखने का आखिरी समय
3 से 10 दिसंबर, 2020 को 18:00 बजे यूटीसी पर : प्रोजेक्ट की सफलता और मेंटॉर के साथ काम करने का अनुभव सबमिट करना
मेंटॉर के साथ आगे की चर्चा करने के बाद, यहां बताए गए मॉड्यूल के क्रम को बदला जा सकता है.
मेंटॉर के सुझाव के मुताबिक, मेरा फ़ोकस पहले उन मॉड्यूल को अपडेट करने पर होगा जिन्हें आसानी से अपडेट किया जा सकता है और फिर मुश्किल मॉड्यूल वाले मॉड्यूल पर ध्यान दिया जाएगा.
इस प्रोजेक्ट के लिए मैं सही व्यक्ति क्यों हूं?
मुझे लगता है कि इस प्रोजेक्ट के लिए मैं सही व्यक्ति हूं, क्योंकि मुझे कंप्यूटर साइंस की टेक्निकल राइटिंग करने का अच्छा अनुभव है. साथ ही, मुझे गिट और GitHub की अच्छी जानकारी है.
जैसा कि मैंने PRs को सिंपी की नई स्टाइल गाइड में अपडेट करने के लिए, PRs सबमिट कर दिया है और उन्हें मर्ज कर दिया गया है. इसलिए, मुझे वर्कफ़्लो को लेकर भरोसा है और नियमित तौर पर योगदान मिल सकता है.
शुरुआत में जब मैंने योगदान देना शुरू किया, तो मुझे कुछ गड़बड़ियों का सामना करना पड़ा. आखिर में, मुझे हर बार बदलाव करने से पहले टेस्ट करने और दस्तावेज़ बनाने की आदत हो गई, क्योंकि यह बहुत ज़रूरी है.
मैं इस प्रोजेक्ट में योगदान देने में बहुत सहज हूं और इसके लिए तैयार हूं.