docs(motors): write the API reference docstrings

Takes src/lerobot/motors/ (excluding motors_bus.py, off-limits) to 100% public docstring coverage:
dynamixel, feetech, damiao, robstride, calibration_gui.py, and encoding_utils.py. Also fixes a handful of
pre-existing docstring bugs found along the way (a parameter name that didn't match its signature, missing
argument descriptions, a copy-paste typo).

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
CarolinePascal
2026-08-07 00:42:11 +02:00
parent 741005d719
commit 4f3f696b27
12 changed files with 520 additions and 110 deletions
+53
View File
@@ -21,3 +21,56 @@ See [Bring Your Own Hardware](../integrate_hardware) for adding a new bus, and
## MotorNormMode
[[autodoc]] lerobot.motors.MotorNormMode
## DynamixelMotorsBus
[[autodoc]] lerobot.motors.dynamixel.DynamixelMotorsBus
- all
- is_calibrated
## Dynamixel OperatingMode
[[autodoc]] lerobot.motors.dynamixel.OperatingMode
## Dynamixel DriveMode
[[autodoc]] lerobot.motors.dynamixel.DriveMode
## Dynamixel TorqueMode
[[autodoc]] lerobot.motors.dynamixel.TorqueMode
## FeetechMotorsBus
[[autodoc]] lerobot.motors.feetech.FeetechMotorsBus
- all
- is_calibrated
## Feetech OperatingMode
[[autodoc]] lerobot.motors.feetech.OperatingMode
## Feetech DriveMode
[[autodoc]] lerobot.motors.feetech.DriveMode
## Feetech TorqueMode
[[autodoc]] lerobot.motors.feetech.TorqueMode
## DamiaoMotorsBus
CAN-based bus for Damiao arms. Motors must be switched to MIT control mode to be compatible.
[[autodoc]] lerobot.motors.damiao.DamiaoMotorsBus
- all
- is_connected
- is_calibrated
## RobstrideMotorsBus
CAN-based bus for Robstride motors. Motors must be switched to MIT control mode to be compatible.
[[autodoc]] lerobot.motors.robstride.RobstrideMotorsBus
- all
- is_connected