פרויקט SymPy
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
בדף הזה מפורטים פרטי פרויקט של כתיבה טכנית שאושר להשתתפות בתוכנית Google Season of Docs.
סיכום הפרויקט
- ארגון קוד פתוח:
- SymPy
- כותבים טכניים:
- lglattly
- שם הפרויקט:
- עקביות בין תיאורי המאפיינים
- אורך הפרויקט:
- אורך סטנדרטי (3 חודשים)
תיאור הפרויקט
בפרויקט הזה, אנסה לשפר את העקביות של מסמכי ה-docstring של SymPy.
בעבודה עם החונכים שלי, תחילה הייתי מזהה את הפורמט הרצוי ל-docstring ב-codebase. לאחר מכן, יצרתי מדריך לעיצוב מסמכי העזרה לכל docstrings בקוד. במסגרת העבודה שלי בפרויקט, אטמיע גם את המדריך החדש כדי לעדכן את תוספי התיעוד הקיימים, תוך איסוף של אי-עקביות אחרות, כמו שימוש בשפה או מונחים, וטיפול בהן. אני והמנחים שלי נקבל יחד החלטות עריכה לגבי הטיפול בחוסר העקביות הנוסף הזה, וההעדפות הסגנוניות שייווצרו יתווספו גם הן למדריך.
היעד הסופי של הפרויקט הוא מדריך לעיצוב ולסגנון של מסמכי העזרה, שגם מפתחים וגם שותפים יכולים להשתמש בו כדי לשמור על עקביות ב-docstrings של SymPy עכשיו ובעתיד.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-25 (שעון UTC).
[[["התוכן קל להבנה","easyToUnderstand","thumb-up"],["התוכן עזר לי לפתור בעיה","solvedMyProblem","thumb-up"],["סיבה אחרת","otherUp","thumb-up"]],[["חסרים לי מידע או פרטים","missingTheInformationINeed","thumb-down"],["התוכן מורכב מדי או עם יותר מדי שלבים","tooComplicatedTooManySteps","thumb-down"],["התוכן לא עדכני","outOfDate","thumb-down"],["בעיה בתרגום","translationIssue","thumb-down"],["בעיה בדוגמאות/בקוד","samplesCodeIssue","thumb-down"],["סיבה אחרת","otherDown","thumb-down"]],["עדכון אחרון: 2025-07-25 (שעון UTC)."],[],["The project aims to standardize SymPy's docstrings. The technical writer will collaborate with mentors to define a consistent docstring format and create a documentation guide. This guide will be used to update existing docstrings and address inconsistencies in language and terminology. Mentors and the writer will make editorial decisions about the language, and document them. The outcome is a comprehensive guide for maintaining consistency in SymPy's docstrings.\n"]]
