Update arm docs for Python SDK move_through_joint_positions and get_3d_models - #5284
Update arm docs for Python SDK move_through_joint_positions and get_3d_models#5284Shannon Bradshaw (shannonbradshaw) wants to merge 1 commit into
Conversation
…d_models The Python SDK (viam-python-sdk#1250) added move_through_joint_positions and get_3d_models methods to the Arm component client. The docs explicitly stated these methods were not available in Python. - sdk_protos_map.csv: Add Python method names so the next codegen run adds Python tabs to the auto-generated arm API reference. - move-by-joint-positions.md: Replace "not available in Python" warning with a real Python example using MoveOptions, and remove "(Go)" from the comparison table.
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
viambot
added
the
safe to build
|
This merge needs to be held until the next Python SDK release, but otherwise it looks good. Confirmed with Nick Hehr (@HipsterBrown) that the BREAKING note on the SDK PR is technically correct but doesn't necessitate any extra notation in the documentation. |
|
Hey Shannon Bradshaw (@shannonbradshaw) — this PR has been approved and CI has been green for 3+ business days. Ready to merge? Auto-comment from overwatch. Will not re-nudge for 7 days. |
|
Hey Shannon Bradshaw (@shannonbradshaw) — this PR has been approved and CI has been green for 10+ business days. Ready to merge? Auto-comment from overwatch. Will not re-nudge for 7 days. |
2 similar comments
|
Hey Shannon Bradshaw (@shannonbradshaw) — this PR has been approved and CI has been green for 10+ business days. Ready to merge? Auto-comment from overwatch. Will not re-nudge for 7 days. |
|
Hey Shannon Bradshaw (@shannonbradshaw) — this PR has been approved and CI has been green for 10+ business days. Ready to merge? Auto-comment from overwatch. Will not re-nudge for 7 days. |
4 participants
Source changes
move_through_joint_positionsandget_3d_modelsmethods to the Python SDK Arm component clientDocs changes
.github/workflows/sdk_protos_map.csv: Added Python method names (move_through_joint_positions,get_3d_models) so the next codegen run adds Python tabs to the auto-generated arm API reference pages (arm.md,arm-table.md).docs/motion-planning/move-an-arm/move-by-joint-positions.md: Replaced the "SDK availability" caution alert that saidMoveThroughJointPositionsis "not currently exposed by the Python SDK" with a real Python code example usingMoveOptions. Removed the "(Go)" qualifier from the comparison table. Updated the troubleshooting section to referenceMoveOptionsgenerically instead of "Go'sMoveOptions".How I found these
viam-python-sdkfrom060e393..4395a87showed two new public methods added tosrc/viam/components/arm/arm.pyandclient.pymove_through_joint_positionsandMoveThroughJointPositionsacross the docs repo found three files referencing these methodsNote on generated docs
The auto-generated files (
static/include/components/apis/generated/arm.mdandarm-table.md) are not edited in this PR. They are produced byupdate_sdk_methods.pyfromsdk_protos_map.csv. The CSV update in this PR ensures the next codegen run will add Python tabs forMoveThroughJointPositionsandGet3DModels.Generated by daily docs change agent
Generated by Claude Code
Generated by Claude Code