Addressing some comments #417

ral-facilities · Jan 2, 2025 · 5b9405e · 5b9405e
1 parent 64abc88
commit 5b9405e
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 5 deletions.
diff --git a/inventory_management_system_api/repositories/catalogue_item.py b/inventory_management_system_api/repositories/catalogue_item.py
@@ -228,8 +228,10 @@ def update_number_of_spares(
         Updates the `number_of_spares` field using a given catalogue item id filter.
 
         :param catalogue_item_id: The ID of the catalogue item to update or `None` if updating all.
-        :param number_of_spares: New number of spares to update to.
-        :param session: PyMongo ClientSession to use for database operations
+        :param number_of_spares: New number of spares to update to. A value of `None` can be used to write lock
+                                 the involved documents when updating within a transaction as the actual value will be
+                                 assigned later but the documents should be write locked immediately.
+        :param session: PyMongo ClientSession to use for database operations.
         """
 
         if catalogue_item_id is not None:

diff --git a/inventory_management_system_api/repositories/item.py b/inventory_management_system_api/repositories/item.py
@@ -193,7 +193,7 @@ def count_with_usage_status_ids_in(
         Counts the number of items within a catalogue item with a `usage_status_id` contained within the given list.
 
         :param catalogue_item_id: ID of the catalogue item for which items should be counted.
-        :param usage_status_id: List of usage status IDs which should be included in the count.
+        :param usage_status_ids: List of usage status IDs which should be included in the count.
         :param session: PyMongo ClientSession to use for database operations.
         :return: Number of items counted.
         """

diff --git a/test/unit/repositories/test_item.py b/test/unit/repositories/test_item.py
@@ -656,7 +656,7 @@ def call_count_with_usage_status_ids_in(
         """Calls the `ItemRepo` `count_with_usage_status_ids_in` method.
 
         :param catalogue_item_id: ID of the catalogue item for which items should be counted.
-        :param usage_status_id: List of usage status IDs which should be included in the count.
+        :param usage_status_ids: List of usage status IDs which should be included in the count.
         """
 
         self._count_with_usage_status_ids_in_catalogue_item_id = catalogue_item_id

diff --git a/test/unit/repositories/test_setting.py b/test/unit/repositories/test_setting.py
@@ -234,7 +234,7 @@ def test_get_non_existent_spares_definition(self):
         self.call_get(SparesDefinitionOut)
         self.check_get_success()
 
-    def test_get_existent_spares_definition_but_not_assinged(self):
+    def test_get_existent_spares_definition_but_not_assigned(self):
         """Test getting the spares definition setting when it is existent but only due to a write lock."""
 
         self.mock_get(