Skip to content

docs(#6638): fix doc comment guidance for injectable function variables - #6641

Merged
rh-hemartin merged 1 commit into
mainfrom
agent/6638-fix-doc-comment-guidance
Aug 27, 2026
Merged

docs(#6638): fix doc comment guidance for injectable function variables#6641
rh-hemartin merged 1 commit into
mainfrom
agent/6638-fix-doc-comment-guidance

Conversation

@fullsend-ai-coder

Copy link
Copy Markdown
Contributor

Summary

Fixes inaccurate doc comment guidance in the "Injectable function variables (test seams)" section of docs/contributing/go-code.md. The merged text from PR #6200 documented a convention that doesn't match actual codebase usage, as flagged by the review agent.

Changes

  • Doc comment rule: Changed from "starting with 'Override in tests to...'" to "following Go convention (starting with the variable name) that contains an 'Override in tests to...' sentence" — matching the actual pattern in RetrySleepFn, BuildWASMFn, execCombinedOutputFn, and resolveOverrideFn
  • Unexported variants: Added note that both exported (XxxFn) and unexported (xxxFn) variables follow the Fn-suffix pattern, since the section previously only documented the exported form

Testing

  • Verified the corrected rule matches actual doc comments in internal/sandbox/sandbox.go (RetrySleepFn), internal/dispatch/cf/provisioner.go (BuildWASMFn, execCombinedOutputFn), and internal/sandbox/gateway_endpoint.go (resolveOverrideFn)
  • No Go code changes — docs-only, no test suite applies
  • Pre-commit hooks passed (trailing whitespace, EOF, link checks)

Checklist


Closes #6638

Post-script verification

  • Branch is not main/master (agent/6638-fix-doc-comment-guidance)
  • Secret scan passed (gitleaks — d0d567bb7f882f797898e1d478948a4d82bfd1d6..HEAD)
  • PR body secret scan passed (gitleaks — no-git)

The "Injectable function variables (test seams)" section in
go-code.md documented an inaccurate doc comment convention:
it said to start comments with "Override in tests to..." but
every codebase example (RetrySleepFn, BuildWASMFn,
execCombinedOutputFn, resolveOverrideFn) starts with the
variable name per Go doc-comment convention, with "Override
in tests to..." as a later sentence.

Two fixes:
- Correct the doc comment rule to say "starting with the
  variable name" with an "Override in tests to..." sentence,
  matching actual codebase usage.
- Note that both exported (XxxFn) and unexported (xxxFn)
  variables follow the Fn-suffix pattern, since the section
  previously only mentioned the exported form.

Closes #6638
@fullsend-ai-coder
fullsend-ai-coder Bot requested a review from a team as a code owner August 26, 2026 13:42
@fullsend-ai-coder fullsend-ai-coder Bot added the ready-for-review Triggers review agent dispatch label Aug 26, 2026
@fullsend-ai-review

fullsend-ai-review Bot commented Aug 26, 2026

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 1:44 PM UTC · Completed 1:53 PM UTC

Commit: 9c2f8c7 · View workflow run →

Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $2.35

@github-actions

Copy link
Copy Markdown

Site preview

Preview: https://15a91e98-site.fullsend-ai.workers.dev

Commit: 9c2f8c7c29c3388d836ca4173e9a322868abe42d

@codecov

codecov Bot commented Aug 26, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@fullsend-ai-review fullsend-ai-review Bot added the risk/moderate PR risk: moderate label Aug 26, 2026
@fullsend-ai-review

Copy link
Copy Markdown

Risk Assessment: moderate (2/5)

Details

Minimal 4-line documentation fix by a bot with no protected paths or security sensitivity; elevated only slightly above low due to high recent churn and multi-author activity on this actively-maintained contributing guide.

@fullsend-ai-review

Copy link
Copy Markdown

Looks good to me

@fullsend-ai-review fullsend-ai-review Bot added the ready-for-merge All reviewers approved — ready to merge label Aug 26, 2026
@rh-hemartin
rh-hemartin added this pull request to the merge queue Aug 27, 2026
Merged via the queue into main with commit 739fe44 Aug 27, 2026
77 of 78 checks passed
@rh-hemartin
rh-hemartin deleted the agent/6638-fix-doc-comment-guidance branch August 27, 2026 09:53
@fullsend-ai-retro

fullsend-ai-retro Bot commented Aug 27, 2026

Copy link
Copy Markdown

🤖 Finished Retro · ✅ Success · Started 9:55 AM UTC · Completed 10:07 AM UTC

Commit: 9c2f8c7 · View workflow run →

Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $4.06

@fullsend-ai-retro

Copy link
Copy Markdown

Retro: PR #6641 — docs fix for injectable function variable guidance

Workflow quality: excellent. The retro → triage → code → review → merge pipeline worked as designed with zero rework. The code agent produced the correct 2-line fix on its first attempt, the review agent correctly approved, and the human reviewer concurred.

Timeline

  1. Review agent flagged two accuracy issues on PR #6200 (Aug 13), but findings were posted as COMMENTED and went unaddressed.
  2. PR docs(#6197): document Fn suffix convention for injectable function variables #6200 merged Aug 26 with findings ignored → retro agent filed #6638.
  3. Triage ($0.95) → Code ($1.77) → PR #6641 created within 13 minutes.
  4. Review agent approved ($2.35) → human approved next day → merged.

Total cost: $5.07. The ignored-findings rework cycle (duplicate review on #6200 + full triage/code/review for #6641) cost ~$8+ that would have been avoided if the original findings had been addressed.

Evidence for existing open issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready-for-merge All reviewers approved — ready to merge ready-for-review Triggers review agent dispatch risk/moderate PR risk: moderate

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix inaccurate doc comment guidance in go-code.md injectable function variables section

1 participant