Docstrings for llama_stack_version.py

Author: tisnik

src/utils/llama_stack_version.py

@@ -22,7 +22,15 @@ class InvalidLlamaStackVersionException(Exception):
 async def check_llama_stack_version(
     client: AsyncLlamaStackClient,
 ) -> None:
-    """Check if the Llama Stack version is supported by the LCS."""
+    """
+    Verify the connected Llama Stack's version is within the supported range.
+
+    This coroutine fetches the Llama Stack version from the
+    provided client and validates it against the configured minimal
+    and maximal supported versions. Raises
+    InvalidLlamaStackVersionException if the detected version is
+    outside the supported range.
+    """
     version_info = await client.inspect.version()
     compare_versions(
         version_info.version,
@@ -32,7 +40,23 @@ async def check_llama_stack_version(
 
 
 def compare_versions(version_info: str, minimal: str, maximal: str) -> None:
-    """Compare current Llama Stack version with minimal and maximal allowed versions."""
+    """
+    Validate that a semver version string is within the inclusive [minimal, maximal] range.
+
+    Parses `version_info`, `minimal`, and `maximal` with semver.Version.parse
+    and compares them.  If the current version is lower than `minimal` or
+    higher than `maximal`, an InvalidLlamaStackVersionException is raised.
+
+    Parameters:
+        version_info (str): Semver version string to validate (must be
+        parseable by semver.Version.parse).
+        minimal (str): Minimum allowed semver version (inclusive).
+        maximal (str): Maximum allowed semver version (inclusive).
+
+    Raises:
+        InvalidLlamaStackVersionException: If `version_info` is outside the
+        inclusive range defined by `minimal` and `maximal`.
+    """
     current_version = Version.parse(version_info)
     minimal_version = Version.parse(minimal)
     maximal_version = Version.parse(maximal)