Skip to content

style: make three code comments timeless - #324

Merged
tiana-code merged 1 commit into
mainfrom
feat/code-quality-sweep
Jun 20, 2026
Merged

style: make three code comments timeless#324
tiana-code merged 1 commit into
mainfrom
feat/code-quality-sweep

Conversation

@tiana-code

Copy link
Copy Markdown
Owner

Quality sweep over the merged codebase to bring comments to a maximally senior, timeless form.

Audit result

The codebase is already clean (every slice passed the per-slice code-reviewer + code-simplifier anti-slop gate). Deterministic scans found: 0 em/en-dash in code, 0 TODO/FIXME/XXX/HACK, 0 'In this commit' phrasing. The only findings were three comments that referenced implementation slices or a closed ticket:

  • KycOrchestrator: dropped 'in this slice' (the provider reference is simply not persisted).
  • DecisionRuleController: dropped the 'the full idempotency subsystem is a later slice' aside (the by-design rationale stays).
  • KycApiContextIT: reworded 'No in-tree KycProvider yet (sandbox is F-06.2 SandboxKycProvider #239)' to a timeless note about the fake isolating the web context.

Comment-only, behaviour-preserving. compliance + decision compile, detekt and spotless green locally. The legitimate why-comments (invariants, tx-boundary notes, MapStruct-limitation and JSONB-normalization rationale, fail-closed/ReDoS reasoning) were deliberately kept - they earn their place.

Drop slice and ticket references from code comments so they read as
durable rationale rather than progress notes: the KYC orchestrator no
longer says the provider reference is unpersisted 'in this slice', the
decision rule controller drops the 'later slice' idempotency aside, and
the KYC context test no longer references a closed sandbox issue. No
behaviour change.
@tiana-code
tiana-code merged commit fe0a0fe into main Jun 20, 2026
8 checks passed
@tiana-code
tiana-code deleted the feat/code-quality-sweep branch June 20, 2026 00:43
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