Fix the findings of the 2026-09-07T21-20 comment audit - #19
Merged
Conversation
- C: the breaker-configuration KDoc no longer promises a per-class override path; it states the thresholds are fixed (ADR-0002) - H: seven date-only report references name the immutable report file, as the first audit's rule requires - M: buildPipeline gets a KDoc carrying its transaction contract; the inline block shrinks to its location-bound sentence - M: the reentry-guard KDoc keeps decision and rejected alternative, the VT-cost derivation moves behind the file-named reference - M: the metric inventory is enforced by DocumentationContractTest against the metrics overview (names, tags, enum-derived series counts); the implementation KDoc keeps the invariant only - M: the dispatcher subclasses document only the parameters whose meaning they change; pass-throughs point to the skeleton - L: ignored-exceptions rule condensed to decision + reason with the list left to the code; five in-file above/below pointers replaced; the parser KDoc keeps the two project-specific rules and points to Properties.load for the specification; the stop() gate comment condensed against the lifecycle KDoc; the stale "restart path" clause removed - P2: the I/O-thread rationale in ResilientMessageSender is a hub pointer to FallbackDispatcher with a local residual statement Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015GfdGp7eUrjJKBvcJUx3q2
Second-round comment audit at 850a7e3 (1 Critical, 1 High, 4 Medium, 5 Low, 3 systemic patterns); every finding carries its status line referencing the fix commit. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015GfdGp7eUrjJKBvcJUx3q2
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.
Remediation of
docs/assessment/COMMENT_AUDIT-2026-09-07T21-20-00.md(second comment audit at850a7e3: 1 Critical, 1 High, 4 Medium, 5 Low, 3 patterns), per the review workflow: fix commit first, then the report with per-finding status lines. Comments and KDoc only, plus one test extension.Fixed
buildPipelineKDoc with the transaction contract; reentry-guard KDoc condensed to decision + rejected alternative; the metric inventory is enforced byDocumentationContractTestagainst the metrics overview (names, tags, enum-derived series counts) instead of a hand-mirrored KDoc table; dispatcher subclass@parampass-throughs point to the skeleton.Properties.loadfor the specification;stop()gate comment condensed; stale "restart path" clause removed.ResilientMessageSenderis a hub pointer toFallbackDispatcher.mvn verify(offline, incl. ktlint): 269 tests green;dokka:dokkawithfailOnWarningpasses.🤖 Generated with Claude Code
https://claude.ai/code/session_015GfdGp7eUrjJKBvcJUx3q2