move documentation inside functions

truthseeker/logic/game_logic.py

@@ -55,21 +55,21 @@ class Game:
         self.gamedata = {}
         self.reaction_table = {}
 
+    def set_owner(self, username: str) -> Member:
         """
         Set the owner of the game
 
         :param username: the username of the owner.
         :return: the Member object created by this method
         """
-    def set_owner(self, username: str) -> Member:
         self.owner = Member(username)
         self.members.append(self.owner)
         return self.owner
     
+    def generateGameResults(self) -> None:
         """
         TODO + TODO RET TYPE
         """
-    def generateGameResults(self) -> None:
         data = {}
         npcs = data["npcs"] = {}
         for npc_id in self.gamedata["npcs"]:
@@ -83,50 +83,50 @@ class Game:
             player_results[member.username] = member.results
         return data
 
+    def generate_data(self) -> None:
         """
         TODO
         """
-    def generate_data(self) -> None:
         #TODO Get language from player
         self.gamedata, self.reaction_table = generateGameData("FR")
 
+    def get_member(self, username: str) -> Union[Member, None]:
         """
         Get a Member object from a username
 
         :param username: the username of the member to search for
         :return the member corresponding to the username, or None if none if found:
         """
-    def get_member(self, username: str) -> Union[Member, None]:
         for member in self.members:
             if member.username == username:
                 return member
         
+    def add_member(self, username: str) -> Union[Member, None]:
         """
         Add a Member to the game
 
         :param username: the username of the member to add
         :return: the Member created, or None if a Member with this username already exists in the game
         """
-    def add_member(self, username: str) -> Union[Member, None]:
         if self.get_member(username):
             return None
         member = Member(username)
         self.members.append(member)
         return member
 
+    def get_npc_reaction(self, npc_id, reaction) -> None:
         """
         TODO + TODO TYPES
         """
-    def get_npc_reaction(self, npc_id, reaction) -> None:
         if npc_id not in self.reaction_table.keys():
             return 0
         reaction_id = self.reaction_table[npc_id][int(reaction)]
         return read_image(f"./truthseeker/static/images/npc/{npc_id}/{reaction_id}.png")
     
+    def getPlayerResults(self, responses: dict) -> None:
         """
         TODO + TODO RETTYPE
         """
-    def getPlayerResults(self, responses: dict) -> None:
         results = {}
         try:
             for npc_id in responses:
@@ -137,12 +137,12 @@ class Game:
             return False
 
 
+    def has_finished(self) -> bool:
         """
         Checks if the game has finished by checking if every Member has submitted answers
         
         :return: True if the game has finished, else False
         """
-    def has_finished(self) -> bool:
         for member in self.members:
             if member.results == None : return False
         return True
@@ -186,6 +186,7 @@ def check_username(username: str) -> bool:
     :param username: the username to check
     :return: True or False depending on if the rules are respected
     """
+    
     if not username:
         return False
     if not username.isalnum():