From def52f94e3a708898ac815c80d2133a98dc16d4b Mon Sep 17 00:00:00 2001
From: Marek Wolan <marek.wolan@methods.co.uk>
Date: Tue, 30 Jan 2024 09:56:16 +0000
Subject: [PATCH] Add docstrings and update typos

---
 README.md                                              |  4 ++--
 src/primaite/simulator/file_system/folder.py           |  1 -
 .../system/services/database/database_service.py       | 10 ++++++++++
 3 files changed, 12 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 416bd0ec..7dfe15bd 100644
--- a/README.md
+++ b/README.md
@@ -33,7 +33,7 @@ Currently, the PrimAITE wheel can only be installed from GitHub. This may change
 #### Windows (PowerShell)
 
 **Prerequisites:**
-* Manual install of Python >= 3.9 < 3.12
+* Manual install of Python >= 3.8 < 3.12
 
 **Install:**
 
@@ -56,7 +56,7 @@ primaite session
 #### Unix
 
 **Prerequisites:**
-* Manual install of Python >= 3.9 < 3.12
+* Manual install of Python >= 3.8 < 3.12
 
 ``` bash
 sudo add-apt-repository ppa:deadsnakes/ppa
diff --git a/src/primaite/simulator/file_system/folder.py b/src/primaite/simulator/file_system/folder.py
index ab862898..dae32cd5 100644
--- a/src/primaite/simulator/file_system/folder.py
+++ b/src/primaite/simulator/file_system/folder.py
@@ -276,7 +276,6 @@ class Folder(FileSystemItemABC):
             self.deleted_files[file.uuid] = file
             file.delete()
             self.sys_log.info(f"Removed file {file.name} (id: {file.uuid})")
-            # self._file_request_manager.remove_request(file.uuid)
         else:
             _LOGGER.debug(f"File with UUID {file.uuid} was not found.")
 
diff --git a/src/primaite/simulator/system/services/database/database_service.py b/src/primaite/simulator/system/services/database/database_service.py
index a7c2bb69..c9c4d6fa 100644
--- a/src/primaite/simulator/system/services/database/database_service.py
+++ b/src/primaite/simulator/system/services/database/database_service.py
@@ -151,6 +151,15 @@ class DatabaseService(Service):
     def _process_connect(
         self, connection_id: str, password: Optional[str] = None
     ) -> Dict[str, Union[int, Dict[str, bool]]]:
+        """Process an incoming connection request.
+
+        :param connection_id: A unique identifier for the connection
+        :type connection_id: str
+        :param password: Supplied password. It must match self.password for connection success, defaults to None
+        :type password: Optional[str], optional
+        :return: Response to connection request containing success info.
+        :rtype: Dict[str, Union[int, Dict[str, bool]]]
+        """
         status_code = 500  # Default internal server error
         if self.operating_state == ServiceOperatingState.RUNNING:
             status_code = 503  # service unavailable
@@ -279,6 +288,7 @@ class DatabaseService(Service):
         return super().apply_timestep(timestep)
 
     def _update_patch_status(self) -> None:
+        """Perform a database restore when the patching countdown is finished."""
         super()._update_patch_status()
         if self._patching_countdown is None:
             self.restore_backup()