From 711d562af0fbcfb5f357922c568897b88bf58ecf Mon Sep 17 00:00:00 2001
From: Thomas Rubini <74205383+ThomasRubini@users.noreply.github.com>
Date: Fri, 13 Jan 2023 10:00:36 +0100
Subject: [PATCH] document check_username()

---
 truthseeker/logic/game_logic.py | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/truthseeker/logic/game_logic.py b/truthseeker/logic/game_logic.py
index fefc45e..7363cbb 100644
--- a/truthseeker/logic/game_logic.py
+++ b/truthseeker/logic/game_logic.py
@@ -179,7 +179,13 @@ def get_game(game_id: str) -> Union[Game, None]:
     else:
         return None
 
-def check_username(username):
+def check_username(username: str) -> bool:
+    """
+    Check if a username is valid using a set of rules
+
+    :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():