fix docString

Author: Relm-Arrowny

src/daq_config_server/client.py

@@ -14,18 +14,20 @@ def __init__(
         url: str,
         log: Logger | None = None,
         cache_size: int = 10,
-        cache_lifetime: int = 3600,
+        cache_lifetime_s: int = 3600,
     ) -> None:
         """
         Initialize the ConfigServer client.
 
         Args:
             url: Base URL of the config server.
             log: Optional logger instance.
+            cache_size: Size of the cache (maximum number of items can be stored).
+            cache_lifetime: Lifetime of the cache (in seconds).
         """
         self._url = url.rstrip("/")
         self._log = log if log else getLogger("daq_config_server.client")
-        self._cache = TTLCache(maxsize=cache_size, ttl=cache_lifetime)
+        self._cache = TTLCache(maxsize=cache_size, ttl=cache_lifetime_s)
 
     def _get(
         self,
@@ -34,13 +36,11 @@ def _get(
         reset_cached_result: bool = False,
     ) -> Any:
         """
-        Internal method to get data from the cache config server, with cache
-        management.
-        This method checks if the data is already cached. If it is, it returns
-        the cached data. If not, it fetches the data from the config server,
-        caches it, and returns the data.
-        If reset_cached_result is True, it will remove the cached data and
-        fetch it again from the config server.
+        Get data from the config server with cache management.
+        If a cached response doesn't already exist, makes a request to
+        the config server.
+        If reset_cached_result is true, remove the cache entry for that request and
+        make a new request
 
         Args:
             endpoint: API endpoint.

tests/unit_tests/test_client.py

@@ -108,7 +108,7 @@ def test_read_unformatted_file_cache_custom_lifetime(mock_request: MagicMock):
     ]
     file_path = "test"
     url = "url"
-    server = ConfigServer(url=url, cache_lifetime=0.1)  # type: ignore
+    server = ConfigServer(url=url, cache_lifetime_s=0.1)  # type: ignore
     assert server.read_unformatted_file(file_path) == "1st_read"
     assert server.read_unformatted_file(file_path) == "1st_read"
     sleep(0.1)