דף זה מכיל את הפרטים של פרויקט כתיבה טכנית שהתקבל בעונה של Google Docs.
סיכום הפרויקט
- ארגון הקוד הפתוח:
- SymPy
- כתב טכני:
- Soumi7
- שם הפרויקט:
- עקביות במחרוזות מסמכים שונות – תיעוד של Sympy
- אורך הפרויקט:
- אורך רגיל (3 חודשים)
תיאור הפרויקט
תקציר :
תיעוד מצב נוכחי של Sympy ועבודה קודמת :
יצירת מדריך הסגנון הרשמי עבור SymPy הסתיימה.
פרויקט GSoD של לורן גלטלי יצר מדריך סגנון למסמכי docstring של SymPy, שניתן למצוא במדריך הסגנון של SymPy.
מחרוזות המסמכים בתת-המודול המיוחד ובקובץsolrs.py נערכו כך שיתאימו באופן עקבי להנחיות של מדריך הסגנון החדש
עדיין היה צריך לערוך את כל מחרוזות ה-docstring האחרות ב-codebase כדי לעמוד בדרישות של מדריך הסגנון החדש.
עבודה מוצעת :
רוב מחרוזות ה-docstring ב-SymPy עדיין לא תואמות למדריך הסגנון העדכני ביותר. מטרת הפרויקט הזה היא לעדכן את docstrings בכל SymPy בהתאם למדריך הזה.
דנתי בפרויקט עם מנטורים. מצורף קישור לדיון.
הוחלט שעריכת docstrings בכל ה-codebase של sympy בהתאם למדריך הסגנון האחרון היא משימה גדולה, ויש להגביל את הפרויקט לזה.
העבודה שלי בפרויקט תהיה כרוכה בהטמעה של המדריך החדש לעדכון מחרוזות מסמכים קיימים, תוך איסוף של חוסר עקביות אחר כמו שימוש בשפה או תנאים, וטיפול בהם.
אפשר לשנות או להחליט את הסדר של קטעי המשנה הקיימים מאוחר יותר או כמשימה נפרדת.
הדגמת ההבדלים בתוצאות כאשר ערכים שונים מועברים לפרמטרים באמצעות הוספת דוגמאות יחד עם קטע של פרמטרים.
המשיכו להוסיף דוגמאות מורכבות לקטעי החסרונות.
תרומות: - #17887 : עבד על בעיה מס' 17887: הוספת קטעי docstring חסרים במודול המשנה המיוחד. הוספתי את הקטע 'פרמטרים ודוגמאות' החסרים בחלק מהפונקציות של המודול המשני 'מבצעים', שנערך על ידי L. פועלים לפי מדריך הסגנון העדכני ביותר ומשמשים כמודל ל-docstrings בעתיד.
הנה הקישור ליחסי יחסי הציבור שלי שמוזגו : https://github.com/sympy/sympy/pull/19334
- #19591 : גיליון מס' 19591 עוקב אחר מדריך הסגנון לתיעוד. הוספתי יח"צ כדי לערוך את docstring של Core.sympify בהתאם למדריך הסגנון העדכני. הוספתי הסברים מובְנים ודוגמאות לשימוש בפרמטרים שונים.
הנה קישור ליחסי הציבור: https://github.com/sympy/sympy/pull/19613
יעדי הפרויקט
ציר זמן לפני 17 באוגוסט :
- להמשיך לתרום לארגון.
- כדאי להכיר את מסמכי התיעוד למשתמש ואת הגרסה הנוכחית של sympy.
- לומדים טכניקות ומיומנויות שיעזרו במהלך יישום הפרויקט.
חיבורים קהילתיים : (17 באוגוסט עד 13 בספטמבר 2020)
- להגדיר ערוץ תקשורת ושעה (עקב הפרשי שעות).
- שפרו את היעדים שלי והגדירו ציפיות משני הצדדים.
- דיון לגבי הסדר שבו יעודכנו המודולים.
- צריך לסיים את הסדר של המודולים לעריכה כדי שיהיו תואמים למדריך הסגנון של docstring.
תקופת תיעוד(14 בספטמבר 2020 עד 30 בנובמבר 2020) :
הגדירו יעדים כדי להשיג כל שבוע, ועדיף להשלים את עדכון docstring של מודול אחד או מודול משנה אחד בכל שבוע.
בכל המודולים האלה, המטרה העיקרית שלי היא להוסיף קטעים חסרים ולבנות מחדש את מחרוזות המסמכים כך שיתאימו למדריך הסגנון העדכני ביותר. במסגרת הניסוי תוכלו להדגים את התוצאות השונות שהתקבלו כשערכים שונים מועברים לפרמטרים. כל תוצרים מסובכים יתווספו לקטע 'שגיאות וטעויות'.
שבוע 1 ( 14 בספטמבר - 21 בספטמבר) : ליבה
שבוע 2 (22 בספטמבר עד 29 בספטמבר) : פונקציות : שילוב של מודולים משניים
שבוע 3 (30 בספטמבר עד 6 באוקטובר) : פונקציות
שבוע 4 (7 באוקטובר עד 14 באוקטובר) : פישוט, קריפטו
שבוע 5 (15 באוקטובר עד 21 באוקטובר) : דיופנטין
שבוע 6 (22 באוקטובר עד 29 באוקטובר):Holonomic :Operations submodule
שבוע 7 (30 באוקטובר עד 7 בנובמבר) : Integrals Module(integrals.integrals), Computing Integrals באמצעות Meijer G-Functions
שבוע 8 (8 בנובמבר עד 15 בנובמבר) : פיזיקה, פונקציות בסוף מודול הקטגוריות, מודול יצירת קוד, מודול משנה מיוחד
שבוע 9 (16 בנובמבר עד 23 בנובמבר) : פיזיקה, פונקציות בסוף מודול הקטגוריות, מודול יצירת קוד, מודול משנה מיוחד
שבוע 10 (24 בנובמבר עד 30 בנובמבר) : הקטע 'טעויות וטעויות'
30 בנובמבר עד 5 בדצמבר 2020 בשעה 18:00 UTC : הגשת פרויקט סופי וכתיבת דוחות
3 עד 10 בדצמבר 2020 בשעה 18:00 UTC : הגשת מועמדות לפרויקט וניסיון בעבודה עם מנטורים
ניתן לשנות את הסדר של המודולים שהוזכרו כאן לאחר דיון נוסף עם המנטורים.
בהתאם להצעה של המנטורים, אתמקד קודם בעדכון המודולים האלה שקל יותר לעדכן, ולאחר מכן אעבור למודולים המורכבים.
למה אני האדם המתאים לפרויקט הזה?
לדעתי אני האדם הנכון לפרויקט הזה, כי יש לי ניסיון בעבר בכתיבה טכנית במדעי המחשב ויש לי ניסיון ב-Git ו-GitHub.
שלחתי מחלקת יחסי ציבור כדי לעדכן את המסמכים למדריך הסגנון העדכני ביותר ב-sympy שמוזגו בהצלחה, ולכן אין לי ספק לגבי זרימת העבודה ואשמח לתרום על בסיס קבוע.
בהתחלה כשהתחלתי להוסיף תוכן, נתקלתי בכמה שגיאות. סוף סוף התרגלתי להריץ את הבדיקות ולבנות את המסמכים בכל פעם לפני ביצוע השינויים, כי זה חשוב מאוד.
יש לי שביעות רצון גבוהה לתרום לפרויקט הזה ואני מצפה לכך.