From 097c611742b7480b161795fcfafba654365c3f5f Mon Sep 17 00:00:00 2001
From: bain <bain@bain.cz>
Date: Fri, 20 Jan 2023 11:11:41 +0100
Subject: [PATCH] docs: add missing documentation to methods

---
 pronotepy/dataClasses.py | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/pronotepy/dataClasses.py b/pronotepy/dataClasses.py
index e6bfff2..056da23 100644
--- a/pronotepy/dataClasses.py
+++ b/pronotepy/dataClasses.py
@@ -835,6 +835,7 @@ def __init__(self, client: ClientBase, json_dict: dict) -> None:
 
     @property
     def normal(self) -> bool:
+        """Is the lesson considered normal (is not detention, or an outing)."""
         if self.detention is None and self.outing is None:
             return True
         return False
@@ -970,9 +971,11 @@ def make_attachments(questions: dict) -> List[Attachment]:
 
     @property
     def content(self) -> str:
+        """Content of the information"""
         return Util.html_parse(self._raw_content[0]["texte"]["V"])
 
     def mark_as_read(self, status: bool) -> None:
+        """Mark this information as read"""
         data = {
             "listeActualites": [
                 {
@@ -1273,6 +1276,9 @@ def address(self) -> tuple[str, str, str, str, str, str, str, str]:
 
     @property
     def email(self) -> str:
+        """
+        Email of the client
+        """
         return self._cache()["eMail"]
 
     @property
@@ -1288,6 +1294,9 @@ def phone(self) -> str:
 
     @property
     def ine_number(self) -> str:
+        """
+        INE number of the client
+        """
         return self._cache()["numeroINE"]
 
 
@@ -1583,6 +1592,12 @@ def __init__(self, client: ClientBase, json_dict: dict) -> None:
         del self._resolver
 
     def students(self, period: Optional[Period] = None) -> List[Student]:
+        """
+        Get students in the class
+
+        Args:
+            period (Optional[Period]): select a particular period (client.periods[0] by default)
+        """
         period = period or self._client.periods[0]
         r = self._client.post(
             "ListeRessources",