Merge branch 'feat-add-docstring-run' into 'fix-linting'

Added docstring for module and functions.

See merge request louistw/self-reg-form!2

run.py

+"""
+This python script conatins functions that talk with Flask frontend over socketio. 
+It has functions to join a unique room, creating an account and certifying an account.    
+"""
 # run.py
 
 # standard imports
@@ -28,6 +32,13 @@ socketio = SocketIO(
 
 @socketio.on("join_room")
 def on_room(json):
+    """
+    This function creates a unique room/flask session id, and joins it
+    Input:
+        json: conatins config information for the flask session
+    Output:
+        Join the unique room.
+    """
     room = str(session["uid"])
     referrer = json["referrer"]
     join_room(room)
@@ -37,6 +48,14 @@ def on_room(json):
 
 @socketio.on("request account")
 def request_account(json, methods=["GET", "POST"]):
+    """
+    This function is called by the Flask frontend on an account request.
+    Input:
+        json: This contains information needed for the user that needs to be created from the frontend.
+        methods: Defaults to ["GET", "POST"].
+    Output:
+        Send the json to Celery tasks file for account creation.
+    """
     print(
         time.strftime("%m-%d-%Y_%H:%M:%S")
         + "\tQueue request received: "
@@ -57,6 +76,14 @@ def request_account(json, methods=["GET", "POST"]):
 
 @socketio.on("request certification")
 def certify_account(json, methods=["GET", "POST"]):
+    """
+    This function is called by the Flask frontend from self certification page.
+    Inputs:
+        json: Conatins information about the user that needs to be certified from the frontend.
+        methods: Defaults to ["GET", "POST"].
+    Outputs:
+        Send the json to Celery tasks file for user certification.
+    """
     print(
         time.strftime("%m-%d-%Y_%H:%M:%S")
         + "\tQueue request received: "