docs: correct dig-mempool README and reserved error-variant docs - #2
Merged
Conversation
Replace the stale `dig-coinstate` README placeholder with the crate's actual name, purpose, boundary, and doc pointers. Correct two MempoolError doc-comments that described behaviour the crate does not currently produce: `FeeTooLow` claimed it was "Returned when utilization >= 80%" (utilization-based rejection is not wired into admission), and `Conflict` claimed the bundle "has been added to the conflict cache" (unmet-RBF conflicts surface via the specific `Rbf*` variants). Both are now documented as reserved / not currently constructed, matching the code. Co-Authored-By: Claude <noreply@anthropic.com>
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.
What changed
Documentation-only honesty fixes surfaced by an architecture audit of this crate:
# dig-coinstateplaceholder (copy-paste leftover from another crate) with the actual crate name, one-paragraph purpose, the input/output boundary, and pointers toSPEC.md+ the requirement catalog. This is the crates.io front page, so the wrong name was user-visible.src/error.rsdoc-comments — corrected twoMempoolErrorvariants whose docs described behaviour the crate does not currently produce:FeeTooLowclaimed it was "Returned when utilization >= 80% …" — utilization-based rejection is not wired into admission (estimate_min_fee()is advisory only), so the variant is never constructed. Now documented as reserved / not currently constructed.Conflict(Bytes32)claimed "The bundle has been added to the conflict cache …" — unmet-RBF conflicts are surfaced through the specificRbf*variants, so this catch-all is never constructed. Now documented as reserved.Grep-confirmed both variants have zero construction sites in
src/outside their definitions.Why
Public API docs advertised failure modes/behaviour the code never produces (§2.5 readable-code, §6.2 doc honesty). No behaviour change.
Verification
Doc-only + README; no logic touched. Version-increment gate satisfied.
Version bump
0.1.1 → 0.1.2(patch) — documentation-only, no public API or behaviour change (§2.4 SemVer).Generated by Claude Code