docs: fix the inaccuracy tail (I2–I15)#79
Merged
Conversation
Resolve the 14 cataloged inaccuracies from the 2026-06-13 docs audit; each verified against source before editing. - I2: exception_type DLQ tag is omitted (not None) for no-exception terminals — fixed observability.md:61 and dlq.md:144 (usecase.py:728). - I3: "first eight" PromQL → "first seven". - I4: name PrometheusRecorder as the source of the faststream_outbox_* series and contrast the native middleware. - I5: note status="error" also counts lease_lost (prometheus.py:277). - I6: drop the "strict subset" overstatement that contradicted the bus-gap list. - I7: replace private _RetryStrategyTemplate with public ExponentialRetry/NoRetry (comparison.md + adjacent subscriber.md). - I8: align the Kafka consumer bootstrap to localhost:9092 and fix the listener prose to match the advertised address. - I9: spell the full get_next_attempt_delay signature in the example. - I10: state get_one()/__aiter__ raise NotImplementedError. - I11: broker._subscribers is a WeakSet, not a list. - I12: name the dispatch_one seam in the worker-loop description. - I13: explain the Postgres 12+ vs 17 gap. - I14: name the outbox_lease_ck CHECK constraint in basic.md. - I15: add the Check constraints block to the tutorial \d outbox output. mkdocs build --strict clean. Co-Authored-By: Claude Opus 4.8 (1M context) <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.
Resolves the 14 cataloged inaccuracies (I2–I15) from the 2026-06-13 docs
audit (
planning/audits/2026-06-13-docs-audit-findings.md). Each wasverified against source before editing;
mkdocs build --strictis clean.Findings fixed
exception_typeDLQ tag is omitted (notNone) for no-exception terminals (usecase.py:728)PrometheusRecorderas the source of thefaststream_outbox_*series; contrast the native middlewarestatus="error"also countslease_lost(prometheus.py:277)_RetryStrategyTemplate→ publicExponentialRetry/NoRetrylocalhost:9092; prose matches the advertised listenerget_next_attempt_delaysignatureget_one()/__aiter__raiseNotImplementedErrorbroker._subscribersis aWeakSet, not a listdispatch_oneseamoutbox_lease_ckCHECK constraintCheck constraints:block to the\d outboxoutputContext
Successor work to the same audit's already-merged bug fixes (B1–B5) and
CLAUDE.md source-of-truth drifts (C1–C3). After this, only the
improvement tail (P1–P18) remains open in the audit register.
🤖 Generated with Claude Code