Add examples in docs for component CMs

src/glasses3/recordings/__init__.py

@@ -172,9 +172,9 @@ async def stop_children_handler_tasks(self) -> None:
 
     @property
     def events(self) -> asyncio.Queue[Tuple[RecordingsEventKind, SignalBody]]:
-        """The event queue containing added and removed recording events.
+        """An event queue containing added and removed recording events.
 
-        Is updated in the context `keep_updated_in_context`."""
+        Is kept updated in the context `keep_updated_in_context`."""
         return self._events
 
     @property
@@ -207,7 +207,19 @@ def __getitem__(self, key: Union[int, slice]) -> Union[Recording, List[Recording
 
     @asynccontextmanager
     async def keep_updated_in_context(self):
-        """Keep the `Recordings` state continuously updated in the context by listening for added and removed recordings."""
+        """Keep the `Recordings` state continuously updated in the context by listening for added and removed recordings.
+
+        Example usage:
+        ```
+        async with g3.recordings.keep_updated_in_context():
+            await g3.recorder.start()
+            await asyncio.sleep(3)
+            await g3.recorder.stop()
+
+            print(len(g3.recordings)) # current number of recordings on device
+            print(await g3.recordings.events.get()) # next event from the event queue
+        ```
+        """
         await self.start_children_handler_tasks()
         try:
             yield

src/glasses3/rudimentary.py

@@ -167,7 +167,15 @@ async def subscribe_to_sync_port(
 
     @asynccontextmanager
     async def keep_alive_in_context(self):
-        """Regularly sends keep alive messages to keep rudimentary streams alive."""
+        """Regularly sends keep alive messages to keep rudimentary streams alive.
+
+        Example usage:
+        ```
+        async with g3.rudimentary.keep_alive_in_context():
+            for _ in range(100):
+                print(await g3.rudimentary.get_gaze_sample())
+        ```
+        """
         await self.start_streams()
         try:
             yield

src/glasses3/zeroconf.py

@@ -322,7 +322,7 @@ def services(self) -> List[G3Service]:
         return list(self._services_handler.services.values())
 
     @staticmethod
-    async def wait_for_single_service(  # TODO: Add timeout
+    async def wait_for_single_service(
         events: asyncio.Queue[Tuple[EventKind, G3Service]],
         ip_version: IPVersion = IPVersion.All,
     ) -> G3Service: