Skip to content

Fix Go-tab loss for methods inherited via framesystem.InputEnabled#5194

Open
btshrewsbury-viam wants to merge 1 commit into
mainfrom
docs/scraper-inputenabled-go-tabs
Open

Fix Go-tab loss for methods inherited via framesystem.InputEnabled#5194
btshrewsbury-viam wants to merge 1 commit into
mainfrom
docs/scraper-inputenabled-go-tabs

Conversation

@btshrewsbury-viam

Copy link
Copy Markdown
Collaborator

Problem

The Go method scraper (parse_go.py) reads each resource's own pkg.go.dev page for inline methods. Methods inherited via the embedded framesystem.InputEnabled interface — CurrentInputs and GoToInputs — render on the interface's page, not the resource's, so the inline scraper never finds them. A pre-existing guard in update_sdk_methods.py then blanks the Go method, dropping the Go tab on the next regeneration.

Net effect: gripper's GetCurrentInputs / GoToInputs sections 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.py already special-cases the framesystem.InputEnabled block — but only added Kinematics. This adds CurrentInputs and GoToInputs there too (the interface's other two methods), following the same pattern as the resource.Actuator / resource.Shaped blocks.

update_sdk_methods.py: add CurrentInputs / GoToInputs to the Go unused-method ignore list, so arm and gantry — which embed InputEnabled but do not map these in sdk_protos_map.csv — don't raise spurious coverage warnings.

Verification (ran the generator locally)

  • gripper: Go tabs restored for both methods, with correct signatures, types ([]referenceframe.Input), and framesystem#InputEnabled links.
  • arm / gantry: no new sections (they have no CSV rows for these), no unused-method warnings, existing Kinematics Go tab intact.
  • Both scripts py_compile cleanly.

Notes

  • The restored Go tabs carry the signature + a "For more information" link but not the inline param/return prose descriptions or code samples the old committed output had (those came from inline scraping that no longer happens). If desired, those can be added later via overrides/methods/go.gripper.* files. The essential Go documentation is restored.
  • Sequencing: this only fixes future regenerations. Document GetStatus across component and service APIs #5184's already-generated gripper.md still 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

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
@netlify

netlify Bot commented Jul 13, 2026

Copy link
Copy Markdown

Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit 03cd1e1
🔍 Latest deploy log https://app.netlify.com/projects/viam-docs/deploys/6a555b15d7f8530008c4f6a6
😎 Deploy Preview https://deploy-preview-5194--viam-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 40 (🔴 down 1 from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 92 (no change from production)
PWA: 60 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Jul 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

safe to build This pull request is marked safe to build from a trusted zone

Projects

None yet

Development

Successfully merging this pull request may close these issues.

SDK method generator drops Go tabs for methods inherited via embedded interfaces (gripper CurrentInputs/GoToInputs)

3 participants