mirror of
https://github.com/huggingface/lerobot.git
synced 2026-08-08 17:39:44 +00:00
CarolinePascal
2178e11eaa
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>
20 lines
1.0 KiB
Plaintext
20 lines
1.0 KiB
Plaintext
# Files whose docstring examples are executed by `make doctest`.
|
|
#
|
|
# This is an ALLOWLIST: only the paths below are collected. transformers started the same way and has since
|
|
# inverted to a denylist (`utils/not_doctested.txt`), which is the better end state — it makes a new file
|
|
# tested by default. LeRobot cannot start there: at the time of writing, public docstring coverage is under
|
|
# 50% and only a handful of files carry any example at all, so a denylist would need hundreds of entries on
|
|
# day one and would say nothing about what is actually verified.
|
|
#
|
|
# Invert once coverage is high enough that the exclusions are the short list.
|
|
# `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
|
|
src/lerobot/robots/so_follower/so_follower.py
|
|
src/lerobot/robots/utils.py
|
|
src/lerobot/teleoperators/teleoperator.py
|