docs: backfill package comment and fix OperationType doc convention - #205
Open
iamlasse wants to merge 1 commit into
Open
docs: backfill package comment and fix OperationType doc convention#205iamlasse wants to merge 1 commit into
iamlasse wants to merge 1 commit into
Conversation
Add a package doc comment to cmd/provider-calibration (the only package out of 25 lacking one) and correct the internal/security.OperationType comment to follow the Go 'name-first' doc convention. Nightshift-Task: docs-backfill Nightshift-Ref: https://github.com/marcus/nightshift
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
1 participant
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.
Summary
Backfills the two genuine documentation gaps found by measuring real coverage across the Go codebase.
The codebase is already ~100% documented — all 299 exported declarations have Go doc comments, and 24 of 25 packages have package-level doc comments (verified via `go doc`). Only two gaps remained, both fixed here:
`cmd/provider-calibration` — the one package without a package doc comment. Added a `Command`-prefixed doc comment describing the tool (compares Codex CLI token usage across `codex_originator` variants to calibrate per-provider budget attribution; run via `make calibrate-providers`).
`internal/security.OperationType` — its doc comment (`// Operation types for safety checks.`) violated the Go "name-first" doc convention (the comment should begin with the symbol name). Corrected to `// OperationType categorizes an operation performed by an agent for safety checks.`
Verification
The website docs (`task-reference.md`, `tasks.md`) were checked and are already in sync with all 59 builtin task types, so no website changes were needed. Scope is intentionally minimal and targets only the genuine gaps.
Nightshift-Task: docs-backfill
Nightshift-Ref: https://github.com/marcus/nightshift
Automated by nightshift