docstrings

Author: Andrei Neagu

services/dynamic-scheduler/src/simcore_service_dynamic_scheduler/api/ui/_services.py

@@ -11,7 +11,11 @@
 
 from ..dependencies import get_app
 from ._constants import API_ROOT_PATH
-from ._sse_utils import AbstractSSERenderer, render_items_on_change, update_items
+from ._sse_utils import (
+    AbstractSSERenderer,
+    render_items_on_change,
+    update_renderer_items,
+)
 
 _PREFIX: Final[str] = "/services"
 
@@ -81,7 +85,7 @@ async def _publish_mock_data(self) -> None:
             await asyncio.sleep(3)
 
             messages.append({"name": "a", "surname": "b"})
-            await update_items(
+            await update_renderer_items(
                 self.app, renderer_type=ServicesSSERenderer, items=messages
             )
 

services/dynamic-scheduler/src/simcore_service_dynamic_scheduler/api/ui/_sse_utils.py

@@ -123,9 +123,10 @@ async def render_items_on_change(
             last_update_id = update_id
 
 
-async def update_items(
+async def update_renderer_items(
     app: FastAPI, *, renderer_type: type[AbstractSSERenderer], items: list[Any]
 ) -> None:
+    """Propagates new changes for each type of registered renderer"""
     await RendererManager.get_from_app_state(app).update_renderers(renderer_type, items)