Fix Go-tab loss for methods inherited via framesystem.InputEnabled#5194
Open
btshrewsbury-viam wants to merge 1 commit into
Open
Fix Go-tab loss for methods inherited via framesystem.InputEnabled#5194btshrewsbury-viam wants to merge 1 commit into
btshrewsbury-viam wants to merge 1 commit into
Conversation
The Go method scraper reads each resource's own pkg.go.dev page. Methods inherited via the embedded framesystem.InputEnabled interface (CurrentInputs, GoToInputs) render on the interface's page, not the resource's, so the inline scraper misses them and a pre-existing guard blanks the Go tab on regeneration. This dropped the only Go documentation for gripper's GetCurrentInputs/GoToInputs from the docs site. parse_go.py already special-cases the InputEnabled block but only added Kinematics. Add CurrentInputs and GoToInputs there too, matching the interface's actual methods. Add both to the Go unused-method ignore list in update_sdk_methods.py so arm/gantry (which embed InputEnabled but do not map these in the CSV) do not raise spurious coverage warnings. Verified by regenerating gripper (Go tabs restored with correct signatures and links) and arm/gantry (no new sections, no unused warnings, Kinematics intact). Fixes #5192
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Nick Hehr (HipsterBrown)
approved these changes
Jul 14, 2026
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.

Problem
The Go method scraper (
parse_go.py) reads each resource's ownpkg.go.devpage for inline methods. Methods inherited via the embeddedframesystem.InputEnabledinterface —CurrentInputsandGoToInputs— render on the interface's page, not the resource's, so the inline scraper never finds them. A pre-existing guard inupdate_sdk_methods.pythen blanks the Go method, dropping the Go tab on the next regeneration.Net effect: gripper's
GetCurrentInputs/GoToInputssections lose their Go tab, and since gripper is the only page documenting these methods, their Go documentation disappears from docs.viam.com entirely. Surfaced while reviewing #5184.Fix
parse_go.pyalready special-cases theframesystem.InputEnabledblock — but only addedKinematics. This addsCurrentInputsandGoToInputsthere too (the interface's other two methods), following the same pattern as theresource.Actuator/resource.Shapedblocks.update_sdk_methods.py: addCurrentInputs/GoToInputsto the Go unused-method ignore list, so arm and gantry — which embedInputEnabledbut do not map these insdk_protos_map.csv— don't raise spurious coverage warnings.Verification (ran the generator locally)
[]referenceframe.Input), andframesystem#InputEnabledlinks.KinematicsGo tab intact.py_compilecleanly.Notes
overrides/methods/go.gripper.*files. The essential Go documentation is restored.gripper.mdstill has the tabs dropped; regenerate gripper after this merges (or before merging Document GetStatus across component and service APIs #5184) to restore them in committed content.Fixes #5192
🤖 Generated with Claude Code