docs(#6638): fix doc comment guidance for injectable function variables - #6641
Conversation
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
|
🤖 Finished Review · ✅ Success · Started 1:44 PM UTC · Completed 1:53 PM UTC Commit: Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $2.35 |
Site previewPreview: https://15a91e98-site.fullsend-ai.workers.dev Commit: |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
|
Risk Assessment: moderate (2/5) DetailsMinimal 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. |
|
Looks good to me |
|
🤖 Finished Retro · ✅ Success · Started 9:55 AM UTC · Completed 10:07 AM UTC Commit: Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $4.06 |
Retro: PR #6641 — docs fix for injectable function variable guidanceWorkflow 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
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
|
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
RetrySleepFn,BuildWASMFn,execCombinedOutputFn, andresolveOverrideFnXxxFn) and unexported (xxxFn) variables follow theFn-suffix pattern, since the section previously only documented the exported formTesting
internal/sandbox/sandbox.go(RetrySleepFn),internal/dispatch/cf/provisioner.go(BuildWASMFn,execCombinedOutputFn), andinternal/sandbox/gateway_endpoint.go(resolveOverrideFn)Checklist
!for breaking changes)Closes #6638
Post-script verification
agent/6638-fix-doc-comment-guidance)d0d567bb7f882f797898e1d478948a4d82bfd1d6..HEAD)