Update documentation based on feedback

- Further usability in 2.2.4 - More test data in 2.3.1.1.1 & 2.3.2.2.1 - Code commenting discussed and explained in 3.32 - Further development ideas given own section in 4.3.13 - Further development for usability covered in 4.3.13.4
MattIPv4 · May 9, 2019 · 649dbc4 · 649dbc4
1 parent daafa80
commit 649dbc4
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 0 deletions.
diff --git a/documentation/FINAL SLST Duty Rota System.pdf b/documentation/FINAL SLST Duty Rota System.pdf
diff --git a/documentation/SLST Duty Rota System.docx b/documentation/SLST Duty Rota System.docx
diff --git a/slst-rota/app/utils.py b/slst-rota/app/utils.py
@@ -19,22 +19,29 @@ def absolute_path(relative: str) -> str:
     def fetch_status_messages():
         # Try from the API to get latest (and save locally)
         try:
+            # Log attempt
             Utils.log("Utils.fetch_status_messages", "Attempting to load from API...")
+            # Fetch JSON data
             resp = requests.get(url="https://status.js.org/codes.json", timeout=5)
             data = resp.json()
             if data:
+                # If valid data, store to variable & to file
                 Utils.statusMessageData = data
                 with open(Utils.absolute_path("assets/statusMsg.json"), "w") as file:
                     json.dump(data, file, sort_keys=True, indent=4)
                 Utils.log("Utils.fetch_status_messages", "Loaded from API")
         except Exception as e:
+            # If error gets raised by requests, assume failure and log
             Utils.log("Utils.fetch_status_messages", "Failed to load from API... '{}'".format(str(e)))
             pass
 
         # If API failed, use latest local copy
         if not Utils.statusMessageData:
+            # If the local fallback file exists
             if os.path.isfile(Utils.absolute_path("assets/statusMsg.json")):
+                # Open the file
                 with open(Utils.absolute_path("assets/statusMsg.json")) as file:
+                    # Load JSON contents into variable and log as such
                     Utils.statusMessageData = json.load(file)
                     Utils.log("Utils.fetch_status_messages", "Loaded from local file")