Další dokumentace

prednasky/models.py

@@ -6,7 +6,7 @@ from personalni.models import Organizator, Osoba
 
 class Seznam(models.Model):
 	"""
-		Spojuje :py:class:`Přednášky <prednasky.models.Prednaska>`
+		Spojuje :py:class:`Přednášky <prednasky.models.Prednaska>` a :py:class:`Znalosti <prednasky.models.Znalost>
 		se :py:class:`Soustředěními <soustredeni.models.Soustredeni>`,
 		kde by mohly zaznít, nebo zazní/zazněly.
 	"""
@@ -19,8 +19,8 @@ class Seznam(models.Model):
 
 	class Stav(models.IntegerChoices):
 		""" Stav seznamu přednášek (NAVRH se používá k hlasování viz :py:func:`daný view <prednasky.views.newPrednaska>`). """
-		NAVRH = 1, "Návrh"
-		BUDE = 2, "Bude"
+		NAVRH = 1, "Návrh" #: odpovídá před-soustřeďkové představě o tom, jaké přednášky dělat (dá se o nich třeba hlasovat ap.)
+		BUDE = 2, "Bude" #: odpovídá definitivní představě o tom, co bude/bylo a dá se porovnávat s novými návrhy
 
 	id = models.AutoField(primary_key=True)
 	soustredeni = models.ForeignKey(Soustredeni, null=True, default=None, on_delete=models.PROTECT)
@@ -99,6 +99,9 @@ class Znalost(models.Model):
 	"""
 		Reprezentuje znalost, na kterou se můžeme účastníka ptát (nechat je hlasovat).
 		(Viz :py:class:`HlasováníOZnalostech <prednasky.models.HlasovaniOZnalostech>`.)
+
+		(V podstatě :py:class:`Přednáška <prednasky.models.Prednaska>, jen neobsahuje
+		tolik detailů a v hlasování má jiné odpovědi.)
 	"""
 	class Meta:
 		db_table = "prednasky_znalost"
@@ -118,6 +121,9 @@ class HlasovaniOZnalostech(models.Model):
 		Reprezentuje hlasování jednoho účastníka
 		o jedné :py:class:`Znalosti <prednasky.models.Znalost>`
 		v jednom :py:class:`Seznamu <prednasky.models.Seznam>` (účastníkův pohled se totiž mezi sousy změnit)
+
+		(V podstatě totéž, co :py:class:`Hlasování <prednasky.models.Hlasovani>`, jen má jiné komentáře
+		u odpovědí a místo přednášky odkazuje na znalost.)
 	"""
 	class Odpoved(models.IntegerChoices):
 		""" Na kolik danou znalost účastník ovládá v daném Hlasování (větší číslo = víc zná) """