Fix README CLI-flag docs and markdown syntax#52
Merged
Conversation
- devices/pi_setup.md: split two malformed single-line code fences (```bash ... ```) into proper multi-line blocks; the unclosed fence made the rest of the doc render as one code block - examples/bimanual_lead_follower/README.md: repoint broken link to the moved guide (../../doc/set_persist_id_socket_can.md -> ../../docs/guides/set-persistent-can-ids.md) - i2rt/flow_base/README.md: fix speed/accel link anchor #L500-L501 -> #L742-L743 (the actual max_vel/max_accel definitions) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…ices - README.md: fix CLI flag --gripper_type -> --gripper (motor_chain_robot defines --gripper); fix Python API import to i2rt.robots.get_robot and pass GripperType.LINEAR_4310 enum (a string raised AttributeError); use canonical tyro flag --bilateral-kp - examples/control_with_mujoco/README.md: add no_arm to --arm and flexible_4310 to --gripper (choices are built from the full enums); correct --site (default is auto-detected, not grasp_site) - examples/control_with_viser/control_with_viser.py: exclude ArmType.NO_ARM from --arm choices; the viewer's IK and arm-joint modes are degenerate with no arm (_n_arm=0) - examples/control_with_viser/README.md: add flexible_4310 to --gripper; keep --arm at the four supported variants to match the restricted choices - examples/single_motor_position_pd_control/README.md: correct script path to examples/single_motor_position_pd_control/single_motor_position_pd_control.py Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Corrects documentation defects across the repo's READMEs that were found by auditing every documented CLI command/flag against the actual arg parsers, plus two markdown-rendering/link fixes. Also makes one small source change so the viser tool rejects an arm choice that produces a degenerate (dead-IK) session. Several of these were hard breaks — documented commands that fail outright (wrong flag name, wrong script path, broken Python import).
Changes
```bash ... ```) into proper multi-line blocks; the unclosed fence made the rest of the doc render as one code block../../doc/set_persist_id_socket_can.mdto../../docs/guides/set-persistent-can-ids.md#L500-L501->#L742-L743(the actualmax_vel/max_acceldefinitions)--gripper_type->--gripper(motor_chain_robot defines--gripper); fix Python API import toi2rt.robots.get_robotand passGripperType.LINEAR_4310(a string raisedAttributeErrorviagripper_type.get_xml_path()); use the canonical tyro flag--bilateral-kpno_armto--armandflexible_4310to--gripper(choices are built from the full enums); correct--site(default is auto-detected from gripper, notgrasp_site)ArmType.NO_ARMfrom--armchoices; the viewer's IK and arm-joint modes are degenerate with no arm (_n_arm=0)flexible_4310to--gripper; keep--armat the four supported variants to match the restricted choicesexamples/single_motor_position_pd_control/single_motor_position_pd_control.py(was a non-existenti2rt/scripts/single_motor_pd_pos_control.py)Test Plan
devices/pi_setup.mdin the PR diff and confirm sections 4 & 5 render as real code blocks (not one giant block); confirm the bimanual link and the flow_base#L742-L743anchor both resolve.python examples/control_with_viser/control_with_viser.py --helpshows--arm {yam,yam_pro,yam_ultra,big_yam}andflexible_4310in--gripper;python examples/control_with_viser/control_with_viser.py --arm no_arm --simexits witherror: argument --arm: invalid choice: 'no_arm'.python examples/control_with_mujoco/control_with_mujoco.py --helpshowsno_armin--armandflexible_4310in--gripper.python examples/minimum_gello/minimum_gello.py --helplists--bilateral-kp(and accepts it).examples/single_motor_position_pd_control/single_motor_position_pd_control.pyexists and defines--channel,--motor_id,--kd.python -c "from i2rt.robots.get_robot import get_yam_robot; from i2rt.robots.utils import GripperType; get_yam_robot(channel='can0', gripper_type=GripperType.LINEAR_4310, sim=True)"runs with noImportError/AttributeError.python i2rt/robots/motor_chain_robot.py --channel can0 --gripper linear_4310starts in zero-gravity mode.🤖 Generated with Claude Code