docs(cameras): add explanation of warmup arg in connect

2025-05-20 18:18:13 +02:00
parent 7a4b9f0cbf
commit eb2d967c85
1 changed files with 3 additions and 1 deletions
--- a/lerobot/common/cameras/camera.py
+++ b/lerobot/common/cameras/camera.py
@@ -71,7 +71,9 @@ class Camera(abc.ABC):
        """Establish connection to the camera.

        Args:
-            warmup: If True (default), captures a warmup frame before returning.
+            warmup: If True (default), captures a warmup frame before returning. Useful
+                   for cameras that require time to adjust capture settings.
+                   If False, skips the warmup frame.
        """
        pass