add comments and improve docstring

Author: threcc

tests/model_serving/model_server/conftest.py

@@ -420,6 +420,7 @@ def gpu_model_car_inference_service(
 
 # Kueue Fixtures
 def _is_kueue_operator_installed(admin_client: DynamicClient) -> bool:
+    """Check if the Kueue operator is installed and ready."""
     try:
         csvs = list(
             ClusterServiceVersion.get(
@@ -440,14 +441,17 @@ def _is_kueue_operator_installed(admin_client: DynamicClient) -> bool:
 def ensure_kueue_unmanaged_in_dsc(
     admin_client: DynamicClient, dsc_resource: DataScienceCluster
 ) -> Generator[None, Any, None]:
+    """Set DSC Kueue to Unmanaged and wait for CRDs to be available."""
     try:
         if not _is_kueue_operator_installed(admin_client):
             pytest.skip("Kueue operator is not installed, skipping Kueue tests")
 
         dsc_resource.get()
         kueue_management_state = dsc_resource.instance.spec.components[DscComponents.KUEUE].managementState
 
+        # ExitStack ensures cleanup runs on teardown or on error
         with ExitStack() as stack:
+            # Patch DSC if needed; ResourceEditor restores original value when exiting the stack
             if kueue_management_state != DscComponents.ManagementState.UNMANAGED:
                 LOGGER.info(f"Updating Kueue from {kueue_management_state} to Unmanaged")
                 dsc_dict = {
@@ -458,6 +462,7 @@ def ensure_kueue_unmanaged_in_dsc(
                 stack.enter_context(ResourceEditor(patches={dsc_resource: dsc_dict}))
                 dsc_resource.wait_for_condition(condition="Ready", status="True", timeout=300)
 
+            # Wait for CRDs before yielding to tests
             wait_for_kueue_crds_available(client=admin_client)
             yield
 

utilities/kueue_utils.py

@@ -182,7 +182,14 @@ def check_gated_pods_and_running_pods(
     sleep=5,
 )
 def wait_for_kueue_crds_available(client: DynamicClient) -> bool:
-    """Wait for Kueue CRDs to be fully available in the API server."""
+    """Wait for Kueue CRDs to be fully available in the API server.
+
+    Raises:
+        TimeoutExpiredError: If CRDs are not available within the timeout period.
+
+    Returns:
+        True when CRDs are available.
+    """
     list(ResourceFlavor.get(client=client))
     LOGGER.info("Kueue CRDs are available")
     return True