Backtick PackageConfig.Name in PackageStatus.name comment to fix TS doc autolink - #897
Open
Jeremy Rose (jeremyrose-viam) wants to merge 1 commit into
Conversation
Jeremy Rose (jeremyrose-viam)
requested a review
from Benjamin Rewis (benjirewis)
September 14, 2026 18:04
Benjamin Rewis (benjirewis)
approved these changes
Sep 14, 2026
Benjamin Rewis (benjirewis)
left a comment
Member
There was a problem hiding this comment.
Sure! Thanks.
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.
tl;dr for human readers
The current line 539 is parsed into a broken link by TypeDoc. The backticks avoid this.
Summary
PackageStatus.namefield comment inrobot.protoreferencesPackageConfig.Nameas plain prose. The TypeScript SDK's TypeDoc build autolinks it because.nameis a valid gTLD, producing a broken link (http://PackageConfig.Name) on the published TS SDK docs at ts.viam.dev/classes/robotApi.PackageStatus.html. This was flagged by the TS SDK's scheduled Link Check workflow (run, auto-filed as DOCS-4941).Verification
typedoc+htmltestlocally: the field now renders as<code>PackageConfig.Name</code>with no link, andhtmltestpasses with 0 errors (previously 2).autoapi+napoleon): reproduced the exact doc pipeline with the backticked string and built with nitpicky mode (-n) — 0 warnings. Renders as<cite>PackageConfig.Name</cite>(docutils' default role), a harmless cosmetic change.pkg.go.dev): field comments render as raw syntax-highlighted source text, not parsed markdown — backticks just show up as literal characters.Test plan
🤖 Generated with Claude Code