From 1421e2b68248c8a631717007dcc11495299f7851 Mon Sep 17 00:00:00 2001
From: Dominik George <dominik.george@teckids.org>
Date: Mon, 11 Nov 2019 11:46:03 +0100
Subject: [PATCH] Add some docstrings.
---
biscuit/apps/alsijil/models.py | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/biscuit/apps/alsijil/models.py b/biscuit/apps/alsijil/models.py
index 79f6f5df1..9540c14e8 100644
--- a/biscuit/apps/alsijil/models.py
+++ b/biscuit/apps/alsijil/models.py
@@ -5,6 +5,10 @@ from biscuit.core.mixins import SchoolRelated
class PersonalNote(SchoolRelated):
+ """ A personal note about a single person. Used in the class register to note
+ absences, excuses and remarks about a student in a single lesson period.
+ """
+
person = models.ForeignKey('core.Person', models.CASCADE, related_name='personal_notes')
week = models.IntegerField()
@@ -23,6 +27,10 @@ class PersonalNote(SchoolRelated):
class LessonDocumentation(SchoolRelated):
+ """ A documentation on a single lesson period. Non-personal, includes
+ the topic and homework of the lesson.
+ """
+
week = models.IntegerField()
lesson_period = models.ForeignKey(
'chronos.LessonPeriod', models.CASCADE, related_name='documentations')
--
GitLab