פרויקט SymPy

דף זה מכיל את הפרטים של פרויקט כתיבה טכני שהתקבל בעונת Google Docs.

סיכום הפרויקט

ארגון הקוד הפתוח:
SymPy
כתב טכני:
Soumi7
שם הפרויקט:
עקביות בין מחרוזות מסמכים – תיעוד של Sympy
אורך הפרויקט:
אורך רגיל (3 חודשים)

תיאור הפרויקט

תקציר :

התיעוד הנוכחי של מצב סימפי ועבודה קודמת :

  • יצירת מדריך הסגנון הרשמי עבור SymPy הושלמה.

  • פרויקט GSoD של לורן גלאטלי יצר מדריך סגנון למחרוזות docstring של SymPy, שניתן למצוא ב-SymPy Compliance Style Guide.

  • מחרוזות ה-docstring בתת-המודול המיוחד ובקובץ shortcuts.py נערכו באופן עקבי בהתאם להנחיות של מדריך הסגנון החדש

  • עדיין היה צריך לערוך את כל מחרוזות ה-docstring האחרות ב-codebase כדי לעמוד בדרישות של מדריך הסגנון החדש.

עבודה מוצעת :

  • רוב מסמכי ה-docstring ב-SymPy עדיין לא תואמים למדריך הסגנון העדכני ביותר. מטרת הפרויקט היא לעדכן את קובצי ה-docstring בכל SymPy, בהתאם למדריך הזה.

  • דנתי על הפרויקט עם מנטורים. מצורף קישור לדיון.

  • כבר הוחלט שעריכת docstrings ב-codebase של sympy בהתאם למדריך הסגנון העדכני ביותר, היא משימה גדולה שצריך להגביל את הפרויקט.

  • עבודתי על הפרויקט תכלול הטמעה של המדריך החדש לעדכון docstring קיימים, תוך איסוף של אי-התאמות אחרות כמו שימוש בשפה או מונחים וטיפול בהן.

  • אפשר לשנות או להחליט את הסדר של קטעי המשנה הקיימים מאוחר יותר או כמשימה נפרדת.

  • הדגמת ההבדלים בתוצאות כאשר ערכים שונים מועברים לפרמטרים על ידי הוספת דוגמאות לצד הוספת קטע של פרמטרים.

  • המשיכו להוסיף דוגמאות מורכבות לקטעי השאלות והשגיאות.

תרומות: - #17887 : עבד על בעיה מס' 17887: יש להוסיף קטעי docstring חסרים במודול המשנה המיוחד. הוספתי את הקטע 'פרמטרים ודוגמאות' החסרים בחלק מהפונקציות של המודול המשני 'מבצעים', שנערכו על ידי L. פועלים במהירות לפי מדריך הסגנון העדכני ביותר, ומשמשים כמודל למחרוזות docstring בעתיד.

הנה הקישור ליחסי הציבור שלי שמוזגו : https://github.com/sympy/sympy/pull/19334

  • #19591 : בעיה מס' 19591 עוקבת אחר מדריך הסגנון של התיעוד. הוספתי PR כדי לערוך את קובץ ה-docstring של Core.sympify בהתאם למדריך הסגנון העדכני. הוספתי הסברים מובנים ודוגמאות לשימוש בפרמטרים שונים.

הנה קישור ליחסי הציבור: https://github.com/sympy/sympy/pull/19613

יעדי הפרויקט

ציר הזמן לפני 17 באוגוסט :

  • להמשיך לתרום לארגון.
  • מומלץ להכיר את מסמכי התיעוד למשתמשים ואת הגרסה הנוכחית של sympy.
  • למדו טכניקות ומיומנויות שיעזרו לכם ליישם את הפרויקט.

גיבוש קהילתי : (17 באוגוסט עד 13 בספטמבר 2020)

  • הגדרת ערוץ תקשורת ושעה (בגלל הפרשי שעות).
  • שפרו את היעדים שלי והגדירו ציפיות משני הצדדים.
  • ניהול דיון לגבי סדר העדכון של המודולים.
  • צריך לסיים את הסדר של עריכת המודולים כך שיהיו תואמים למדריך הסגנון של docstring.

תקופת התיעוד(14 בספטמבר 2020 עד 30 בנובמבר 2020) :

  • צריך להגדיר יעדים להשיג כל שבוע. עדיף לעדכן את ה-docstring של מודול או מודול משנה אחד בכל שבוע.

  • עבור כל המודולים האלה, המטרה העיקרית שלי תהיה להוסיף את הקטעים החסרים ולשנות את המבנה של docstring בהתאם למדריך הסגנון האחרון. הדרכה זו תכלול הדגמה של התוצאות השונות שמתקבלות כאשר מועברים ערכים שונים לפרמטרים. כל הפלטים המורכבים יתווספו לקטע "Gotchas" and Pitfalls.

  • שבוע 1 ( 14 בספטמבר עד 21 בספטמבר) : ליבה

  • שבוע 2 (22 בספטמבר עד 29 בספטמבר) : פונקציות : שילובי מודולים משניים

  • שבוע 3 (30 בספטמבר עד 6 באוקטובר) : פונקציות

  • שבוע 4 (7 באוקטובר עד 14 באוקטובר) : simple, Crypto

  • שבוע 5 (15 באוקטובר עד 21 באוקטובר) : דיופנטין

  • שבוע 6 (22 באוקטובר עד 29 באוקטובר):Holonomic :Operations submodule

  • שבוע 7 (30 באוקטובר עד 7 בנובמבר) : Integrals Module(integrals.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 : בקשה לאישור הפרויקט ולניסיון בעבודה עם מנטורים

  • לאחר דיון נוסף עם החונכים, תוכלו לשנות את הסדר של המודולים שהוזכרו כאן.

  • בהתאם להמלצות שחונכים, אני אתמקד קודם בעדכון המודולים האלה, שקל יותר לעדכן, ולאחר מכן אעבור למודולים המורכבים.

למה אני האדם המתאים לפרויקט הזה?

  • אני מאמין שאני האדם הנכון בפרויקט הזה, כי יש לי ניסיון קודם בכתיבה טכנית במדעי המחשב ויש לי ניסיון ב-GitHub וב-GitHub.

  • שלחתי יחסי ציבור כדי לעדכן את המסמכים למדריך הסגנון החדש ביותר שמוזג בהצלחה, ולכן אין לי ספק בתהליך העבודה שבו השתמשתי ואני רוצה להוסיף תרומות תוכן באופן קבוע.

  • בהתחלה, כשהתחלתי להוסיף תוכן, נתקלתי במספר שגיאות. בסופו של דבר התרגלתי לבצע את הבדיקות ולבנות את המסמכים בכל פעם לפני שביצעתם את השינויים, כי זה חשוב מאוד.

  • שמחתי מאוד לעזור לפרויקט הזה ומצפה לו.