Skip to content

Commit

Permalink
docs: add missing documentation to methods
Browse files Browse the repository at this point in the history
  • Loading branch information
bain3 committed Jan 20, 2023
1 parent a25ad38 commit 097c611
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions pronotepy/dataClasses.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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": [
{
Expand Down Expand Up @@ -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
Expand All @@ -1288,6 +1294,9 @@ def phone(self) -> str:

@property
def ine_number(self) -> str:
"""
INE number of the client
"""
return self._cache()["numeroINE"]


Expand Down Expand Up @@ -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",
Expand Down

0 comments on commit 097c611

Please sign in to comment.