Skip to content

Tidy comments in BoxProvisioning.Sqlite - #4591

Merged
iancooper merged 3 commits into
masterfrom
tidy-comments-sqlite
Oct 12, 2026
Merged

iancooper merged 3 commits into
masterfrom
tidy-comments-sqlite

Conversation

@iancooper

Copy link
Copy Markdown
Member

Slice 2 of the comment tidy over PR #4039's merge (83e0e5e47), bringing src/Paramore.Brighter.BoxProvisioning.Sqlite into line with Comments in Code. Slice 1 was #4590.

Structural only. There are no behaviour changes and no public or protected signature changes.

  • refactor: tidy comments — deletes comments that narrate code or repeat rationale already in ADR 0057 (history-table race, fresh-install fast path), strips spec, issue and PR references, and trims XML remarks that duplicated the runner's or cited other files' line numbers. The busy-timeout note moves above ToDriverBusyTimeoutSeconds, and the LockResourceFor comment becomes XML remarks on the protected override.
  • refactor: extract methods to express intent — decomposes the conditional in SqliteBoxMigrationRunner.ApplyOrSkipAsync into a private IsAlreadyAppliedAsync.

No ADR change was needed: everything removed was already in ADR 0057/0058, or stays in the public XML remarks.

Verification

  • dotnet build src/Paramore.Brighter.BoxProvisioning.Sqlite — no warnings
  • tests/Paramore.Brighter.BoxProvisioning.Tests — 111/111 pass
  • tests/Paramore.Brighter.Sqlite.Tests --filter BoxProvisioning — 66/66 pass, unedited

🤖 Generated with Claude Code

https://claude.ai/code/session_01HsKD52dnGHFLSEr93VZyR7

iancooper and others added 2 commits October 12, 2026 07:41
Delete comments that narrate code or repeat rationale already in ADR 0057,
strip spec, issue and PR references, trim XML remarks that duplicated the
runner's or pointed at other files' line numbers, move the busy-timeout
note above ToDriverBusyTimeoutSeconds, and turn the LockResourceFor
comment into XML remarks on the protected override.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HsKD52dnGHFLSEr93VZyR7
Replace the explanatory comment in SqliteBoxMigrationRunner.ApplyOrSkipAsync
by decomposing its conditional into a private IsAlreadyAppliedAsync, keeping
one line above the signature for the history-row trap the name cannot carry.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HsKD52dnGHFLSEr93VZyR7
@iancooper iancooper closed this Oct 12, 2026
@iancooper
iancooper deleted the tidy-comments-sqlite branch October 12, 2026 07:24
@iancooper iancooper reopened this Oct 12, 2026
@iancooper
iancooper merged commit 85a82f9 into master Oct 12, 2026
59 of 63 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant