בדף הזה מפורטים פרטי פרויקט של כתיבה טכנית שאושר להשתתפות בתוכנית Google Season of Docs.
סיכום הפרויקט
- ארגון קוד פתוח:
- SymPy
- כותבים טכניים:
- lglattly
- שם הפרויקט:
- עקביות בין תיאורי המאפיינים
- אורך הפרויקט:
- אורך סטנדרטי (3 חודשים)
תיאור הפרויקט
בפרויקט הזה, אנסה לשפר את העקביות של מסמכי ה-docstring של SymPy.
בעבודה עם החונכים שלי, תחילה הייתי מזהה את הפורמט הרצוי ל-docstring ב-codebase. לאחר מכן, יצרתי מדריך לעיצוב מסמכי העזרה לכל docstrings בקוד. במסגרת העבודה שלי בפרויקט, אטמיע גם את המדריך החדש כדי לעדכן את תוספי התיעוד הקיימים, תוך איסוף של אי-עקביות אחרות, כמו שימוש בשפה או מונחים, וטיפול בהן. אני והמנחים שלי נקבל יחד החלטות עריכה לגבי הטיפול בחוסר העקביות הנוסף הזה, וההעדפות הסגנוניות שייווצרו יתווספו גם הן למדריך.
היעד הסופי של הפרויקט הוא מדריך לעיצוב ולסגנון של מסמכי העזרה, שגם מפתחים וגם שותפים יכולים להשתמש בו כדי לשמור על עקביות ב-docstrings של SymPy עכשיו ובעתיד.