מחברת 2 - class Path

תגיות:

באמצע המחברת יש דוגמה לתיעוד של class Path.
לא לגמרי הבנתי איך הדוגמה מתיישבת עם שלושת שיטות התיעוד השונות הנתונות בהמשך המחברת.
האם זו שיטת כתיבה רביעית, אישית, ומתאימה גם כן?

היא לא כ"כ :slight_smile:

שיטת התיעוד של Path באמצע המחברת היא בסדר ועונה על PEP 8 ועל PEP 257, שמגדירים נימוסים בנוגע לתיעוד. אם תתעד ככה הכל יהיה בסדר ואף אחד לא יכעס.

מה שכן, בעתיד, כשנבנה קוד קצת יותר ארוך ונרצה ליצור ממנו מסמכי דוקומנטציה – Sphinx פחות ידע לאכול את התיעוד הזה, ולכן עדיף לבחור אחת משיטות התיעוד המסוגננות שמופיעות בהמשך המחברת.
הרעיון של class Path באמצע המחברת היא דוגמת ביניים שנועדה להראות את הטכניקה של תיעוד, אבל לא את סגנונות התיעוד (שהיסטורית, התפתחו מאוחר יותר).

לייק 1