Repository navigation
Regenerate SDK method docs; add arm manual mode/properties and ListRobotsForLocations - #5350
Closed
Jeremy Rose (jeremyrose-viam) wants to merge 2 commits into
Closed
Jeremy Rose (jeremyrose-viam) wants to merge 2 commits into
Jeremy Rose (jeremyrose-viam) wants to merge 2 commits into
Conversation
…botsForLocations Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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.

Regenerates the SDK method reference docs with
update_sdk_methods.pyagainst the current Go, Python (0.82.0), TypeScript, and Flutter SDK docs.New methods
SetManualMode,GetManualMode,GetProperties(new CSV rows; implemented in all four SDKs, from RSDK-14454: Add SetManualMode, GetManualMode and GetProperties to Arm API api#895). Also adds the Python tabs forMoveThroughJointPositionsandGet3DModels, whose CSV mappings landed in Update arm docs for Python SDK move_through_joint_positions and get_3d_models #5284 without a regeneration.ListRobotsForLocations(new CSV row; Python and Go only so far).overrides/protos/for each of the four new methods.Upstream SDK changes picked up
get_robot_part_logsgainsorderandrangeparameters. The SDK docstring forrangeuses "e.g.", which failsViam.AvoidObscure, so there's a parameter override (python.app.get_robot_part_logs.range.md) with the same meaning in house style.binaryDataByIdsnow takes a list of binary data ID strings rather thanBinaryIDobjects.Parser fixes
parse_typescript.py: TypeScript docs now render some parameter types namespace-qualified (for example,appApi.Visibility) as two links, and the parser took the first one, linking to the namespace page. It now skips namespace links to the actual type. This fixesVisibility(app),PowerMode(board), andTransform/PoseInFrame(robot).StreamTicksrenders asch (chan Tick), and audio_outPlaylistschunks (<-chan []byte)instead of a duplicatedinfoparameter.About the slam.md diff
SLAM is semi-deprecated, so it may be surprising to see it change. None of this comes from SDK changes. #5191 restored slam.md as part of bringing SLAM back as an orphan page, and in the process the generated file was hand-formatted (prettier-style quotes and spacing) and a link to the removed
/reference/services/slam/cartographer/page was deleted by hand. Becauseslamstill has rows in the CSV, every scraper run regenerates this file and reverts those edits.overrides/methods/go.slam.Properties.Properties.return.md, so it would have come back on every regeneration. This PR removes it from the override so the fix sticks.Checks
make build-prodpasses.vale3.12.0 (CI's pinned version) reports 0 errors on all changed and added files.getGeometriesacross components, app Sequences,createOAuthAppUser, and others), same as the weeklycheck-methods.ymlrun.🤖 Generated with Claude Code