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