docstrings

api/middleware.py

@@ -3,6 +3,18 @@
 from django.urls import reverse
 
 class RedirectAnonymousUserMiddleware:
+    """
+    Middleware die anonieme gebruikers omleidt naar de inlogpagina.
+    Deze middleware controleert of de gebruiker anoniem is en of het huidige pad niet de inlogpagina is.
+    Als dit het geval is, wordt de gebruiker omgeleid naar de inlogpagina die is geconfigureerd in de instellingen.
+
+    Args:
+        get_response (function): De functie die wordt aangeroepen om het verzoek te verwerken.
+
+    Returns:
+        HttpResponse: Een HTTP-omleiding naar de inlogpagina als de gebruiker anoniem is en het huidige pad niet de inlogpagina is.
+                      Anders wordt het verzoek verder verwerkt door de volgende middleware of de weergavefunctie.
+    """
     def __init__(self, get_response):
         self.get_response = get_response
 

api/utils.py

@@ -36,14 +36,42 @@ def get_graph_token():
         return None
 
 def is_lesgever(user):
+    """
+    Controleert of de gebruiker een lesgever is.
+
+    Args:
+        user (User): De gebruiker waarvan moet worden gecontroleerd of deze een lesgever is.
+
+    Returns:
+        bool: True als de gebruiker een lesgever is, anders False.
+    """
     if user.is_superuser:
         return True
     gebruiker = Gebruiker.objects.get(pk=user.id)
     return gebruiker.is_lesgever
 
 def contains(lijst, user):
+    """
+    Controleert of de gebruiker aanwezig is in de gegeven lijst.
+
+    Args:
+        lijst (QuerySet): De lijst waarin moet worden gecontroleerd.
+        user (User): De gebruiker waarvan moet worden gecontroleerd of deze aanwezig is in de lijst.
+
+    Returns:
+        bool: True als de gebruiker aanwezig is in de lijst, anders False.
+    """
     gebruiker = Gebruiker.objects.get(pk=user.id)
     return lijst.all().contains(gebruiker)
 
 def get_gebruiker(user):
+    """
+    Haalt de Gebruiker-instantie op voor de gegeven gebruiker.
+
+    Args:
+        user (User): De gebruiker waarvoor de Gebruiker-instantie moet worden opgehaald.
+
+    Returns:
+        Gebruiker: De Gebruiker-instantie voor de gegeven gebruiker.
+    """
     return Gebruiker.objects.get(pk=user.id)