docs: post-Phase 6 audit (doc.go, README, rpc.go godoc) - #114
Merged
Conversation
Sweep after PRs #111, #112, #113 to align library-level docs with what the package actually exposes today. doc.go - Headline expanded to "Bitcoin Core or Bitcoin Inquisition" so the package overview matches the README. - Configuration block documents the BinaryPath auto-detect chain (bitcoind-inquisition first, then bitcoind) and the bitcoin-cli sibling-derivation fallback. - New "Soft-fork Testing" section covers VBParams, MineUntilActive vs MineUntilActiveBIP, the curated BIPID registry, ListDeployments, the SupportsBIP skip-when-missing pattern, and Variant(). - Error Handling section: corrected the "bitcoind not found" message to mention both names tried; listed errNotConnected, ErrUnknownDeployment, and ErrUnknownBIP as errors.Is-compatible sentinels. - Prerequisites section: pointer to the README's Inquisition build recipe so doc.go and README stay coherent. README.md - Tagline updated to mention Inquisition alongside Core. - Soft-fork-testing snippet adds an inline note that MineUntilActive / MineUntilActiveBIP wrap the inlined polling loop, and signposts the typed BIPID variant as the preferred form for Inquisition deployments. - Fixed inaccurate description of ListDeployments — returns a []EnrichedDeployment sorted alphabetically by Deployment, not a map "keyed by deployment string." rpc.go - Filled out the Parameters/Returns/Example godoc on Client, GetBlockCount, GetBlockCountContext, HealthCheck, and HealthCheckContext to match the canonical voice used elsewhere in the package (see MineUntilActive in mining.go for reference). - Documented errNotConnected and ctx.Err() return paths so callers can errors.Is against them. No behavioral changes; ai-check green. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
13 tasks
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.
Summary
Post-Phase 6 documentation sweep. No behavioral changes — godoc, README, and
doc.goonly.Driven by parallel audits (godoc-polisher subagent + Explore agent) flagging concrete gaps after PRs #111, #112, #113 landed. Findings the audits reported as missing godoc on
Variant.String/BIPID.String/SoftForkStatus.Stringwere verified false (they already have godoc) and dropped.Changed
doc.goBinaryPathauto-detect chain (bitcoind-inquisitionfirst, fallback tobitcoind) and thebitcoin-clisibling-derivation fallback.VBParams,MineUntilActivevsMineUntilActiveBIP, the curated BIPID registry,ListDeployments, theSupportsBIPskip-when-missing pattern, andVariant().errNotConnected,ErrUnknownDeployment,ErrUnknownBIPaserrors.Is-compatible sentinels.README.mdMineUntilActiveBIPas the typed preferred form for Inquisition deployments.ListDeployments— returns a[]EnrichedDeploymentsorted alphabetically byDeployment, not "keyed by deployment string."rpc.goClient,GetBlockCount,GetBlockCountContext,HealthCheck,HealthCheckContextto match the canonical voice (seeMineUntilActivein mining.go).errNotConnectedandctx.Err()paths so callers canerrors.Isagainst them.Test plan
make ai-checkgreen.go doc github.com/neverDefined/go-regtestreads cleanly with the new sections.🤖 Generated with Claude Code