Skip to content

docs: post-Phase 6 audit (doc.go, README, rpc.go godoc) - #114

Merged
neverDefined merged 1 commit into
mainfrom
docs-phase-6-audit
Apr 26, 2026
Merged

docs: post-Phase 6 audit (doc.go, README, rpc.go godoc)#114
neverDefined merged 1 commit into
mainfrom
docs-phase-6-audit

Conversation

@neverDefined

Copy link
Copy Markdown
Owner

Summary

Post-Phase 6 documentation sweep. No behavioral changes — godoc, README, and doc.go only.

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.String were verified false (they already have godoc) and dropped.

Changed

doc.go

  • Headline mentions Inquisition alongside Core.
  • Configuration block documents the BinaryPath auto-detect chain (bitcoind-inquisition first, fallback to 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: corrected the "bitcoind not found" message; listed errNotConnected, ErrUnknownDeployment, ErrUnknownBIP as errors.Is-compatible sentinels.

README.md

  • Tagline expanded to Core or Inquisition.
  • Soft-fork section signposts MineUntilActiveBIP as the typed preferred form for Inquisition deployments.
  • Fixed wrong description of ListDeployments — returns a []EnrichedDeployment sorted alphabetically by Deployment, not "keyed by deployment string."

rpc.go

  • Filled out Parameters/Returns/Example godoc on Client, GetBlockCount, GetBlockCountContext, HealthCheck, HealthCheckContext to match the canonical voice (see MineUntilActive in mining.go).
  • Documented errNotConnected and ctx.Err() paths so callers can errors.Is against them.

Test plan

  • make ai-check green.
  • go doc github.com/neverDefined/go-regtest reads cleanly with the new sections.
  • No new exported symbols; no API changes; pure docs delta.

🤖 Generated with Claude Code

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>
@neverDefined
neverDefined merged commit c4adbb7 into main Apr 26, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant