ci

src/HABApp/util/ring_counter/ring_counter.py

@@ -56,7 +56,10 @@ def __int__(self) -> int:
         return self._value
 
     def increase(self, value: int = 1) -> Self:
-        """Increase the value of the ring counter by the given value."""
+        """Increase the value of the ring counter by the given value.
+
+        :param value: How much to increase the value by.
+        """
         if value < 0:
             msg = 'Value must be >= 0'
             raise ValueError(msg)
@@ -69,7 +72,10 @@ def increase(self, value: int = 1) -> Self:
         return self
 
     def decrease(self, value: int = 1) -> Self:
-        """Decrease the value of the ring counter by the given value."""
+        """Decrease the value of the ring counter by the given value.
+
+        :param value: How much to decrease the value by.
+        """
         if value < 0:
             msg = 'Value must be >= 0'
             raise ValueError(msg)

src/HABApp/util/ring_counter/ring_counter_tracker.py

@@ -2,7 +2,7 @@
 
 
 class RingCounterTracker:
-    """Class that tracks a ring counter value and only allows increasing values.
+    """Class that tracks a ring counter value and only allows increasing or decreasing values.
     """
 
     __slots__ = ('_ignore', '_is_increasing', '_last_value', '_max_value', '_min_value')

tests/test_utils/test_ring_counter.py

@@ -103,8 +103,6 @@ def test_ring_counter_tracker_increase() -> None:
     assert values == set(range(-10, 11))
 
 
-
-
 def test_ring_counter_tracker_decrease() -> None:
     tracker = RingCounterTracker(100, direction='decreasing')