admin/lerobot
1
0
Fork 0
mirror of https://github.com/huggingface/lerobot.git synced 2026-08-08 17:39:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(cameras): write the API reference docstrings

Browse Source 
Takes src/lerobot/cameras/ to 100% public docstring coverage, the first module of Wave 1 after Person A's
robots/ pilot and infrastructure PR. Converts the three config classes that already had prose but used a
bold **Attributes**: block (invisible to check_docstrings.py, not the standard's Args: pattern for config
dataclasses) and documents the previously-bare CameraConfig, its three enums, ZMQCameraConfig, and the
module's utility functions. Adds per-backend sections to docs/source/api/cameras.mdx and removes the
module's ruff D-ignore.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
CarolinePascal
2026-08-07 00:01:37 +02:00
parent 741005d719
commit 2178e11eaa
18 changed files with 496 additions and 158 deletions
Download Patch File Download Diff File Expand all files Collapse all files
utils/documentation_tests.txt
+1
View File
@@ -10,6 +10,7 @@
# `utils/check_doctest_list.py` does not care which way round it is.
#
# Keep alphabetically sorted: `make check-doctest-list` enforces it, `make fix-docstrings` sorts it.
src/lerobot/cameras/utils.py
src/lerobot/motors/motors_bus.py
src/lerobot/robots/robot.py
src/lerobot/robots/so_follower/config_so_follower.py