docs: file unreleased entries under 0.6.0, drop CLI_NOISE_AUDIT.md, fix a doc comment - #56
Merged
Merged
Conversation
v0.5.0 shipped on 2026-09-21; PR #55 merged after it, but its entries were appended to the frozen [0.5.0] section. A new command plus changed error output is a minor bump, so they move to [0.6.0] and [0.5.0] is restored to exactly what the v0.5.0 tag carries. The changelog feeds release notes and the docs site (release.yml, .goreleaser.yaml, pages.yml), so a misfiled entry would have shipped as the wrong version's notes.
A one-off working audit of stderr narration, reconciled in September and referenced by nothing. .gitignore already designates docs/private/ for local-only planning and audit docs; this one predated that and sat tracked at the repo root instead.
HelpMode was inserted between CLIError's doc comment and the struct, so go doc attributed CLIError's documentation to HelpMode and left CLIError undocumented. Moving HelpMode below the struct rejoins each comment with the type it describes. No behavior change.
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.
Three docs-only fixes. No behavior change, no new changelog entry (nothing user-facing changed).
1. Unreleased entries were filed under a shipped version
v0.5.0was tagged and released 2026-09-21. PR #55 merged 2026-09-23, but its five bullets were appended to the frozen## [0.5.0]section — so the changelog claimedncli profile, the spinner and the new error shapes shipped in v0.5.0, which they didn't.They move to a new
## [0.6.0](new command + changed error output = minor bump).## [0.5.0]is restored to byte-for-byte what the tag carries, verified againstgit show v0.5.0:CHANGELOG.md.This matters because
release.yml,.goreleaser.yamlandpages.ymlall readCHANGELOG.md— left alone, the next release would have published the wrong version's notes.2. Dropped
CLI_NOISE_AUDIT.mdA one-off working audit of stderr narration, reconciled back in September and referenced by nothing (
grepacross the tree returns no hits)..gitignorealready designatesdocs/private/for "Local-only planning/audit docs, not meant to be tracked" — this one predated that convention and sat tracked at the repo root.3. Reattached the
CLIErrordoc commentHelpModewas introduced in #55 betweenCLIError's doc comment and the struct, sogo docattributed CLIError's documentation to HelpMode and leftCLIErrorundocumented. MovingHelpModebelow the struct rejoins each comment with its type.Before/after,
go doc ./cli/common CLIErrornow renders the intended text.Verification
gofmt,go build ./...,go vet ./...,go mod tidy(no diff),go test -short -race ./..., and golangci-lint v2.13.2 — all clean, 0 lint issues.