Strip decorative comment banners and restatements#26
Merged
Conversation
Codebase-wide comment sweep: remove decorative `// ── Section ──` banner
separators and a couple of pure restatement comments ("// main entry point").
No code changed — comment/blank lines only; all "why" notes (protocol/RFC
rationale, keepalive/half-open tuning, foreground-service and EF/FTS5
constraints, DI ordering) are kept. 105 lines removed across 18 files.
Core Connection/Sessions and Domain/Persistence/Platform/Diagnostics were
already lean (no changes). 263 unit tests pass unchanged.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HHCRc5CJ6595iMzEgYYdQp
There was a problem hiding this comment.
Pull request overview
This PR performs a repo-wide cleanup pass to remove decorative comment banners and trivial restatements, keeping only comments that explain non-obvious “why” details. The changes are comment/blank-line only, with no functional code modifications.
Changes:
- Removed decorative
// ── ... ──section/task banners across app, core, data, web, and test code. - Removed a couple of pure restatement comments (e.g., “main entry point”).
- Preserved rationale comments and explanatory documentation where they add non-obvious context.
Reviewed changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| tests/SharpClient.UI.Tests/TriggerEditorTests.cs | Removed decorative section banner between test groups. |
| tests/SharpClient.Tests/Triggers/TriggerEngineTests.cs | Removed decorative “New tests” banner. |
| tests/SharpClient.Tests/Sessions/SessionManagerTests.cs | Removed decorative “New tests” banner. |
| tests/SharpClient.Tests/Sessions/RuntimeWiringTests.cs | Removed decorative task banners separating integration test sections. |
| tests/SharpClient.Tests/Rendering/AnsiPaletteTests.cs | Removed decorative “New tests” banner. |
| tests/SharpClient.Tests/Presentation/TriggerAliasEditorViewModelTests.cs | Removed decorative section banner for character-scope tests. |
| tests/SharpClient.Data.Tests/WorldStoreTests.cs | Removed decorative banners for Add/Get/Update/Delete/Helpers sections. |
| tests/SharpClient.Data.Tests/SessionHistoryTests.cs | Removed decorative banners separating search behavior test sections. |
| src/SharpClient.Web/Program.cs | Removed decorative DI section headers; kept meaningful diagnostics note. |
| src/SharpClient.UI/ServiceCollectionExtensions.cs | Removed decorative headers within shared view model DI registration. |
| src/SharpClient.Data/WorldStore.cs | Removed decorative “IWorldStore”/“Helpers” banners. |
| src/SharpClient.Data/SessionHistory.cs | Removed decorative “ISessionHistory”/“Helpers” banners; kept XML docs. |
| src/SharpClient.Core/Presentation/TriggerAliasEditorViewModel.cs | Removed decorative banners separating regions of the view model. |
| src/SharpClient.Core/Presentation/SettingsViewModel.cs | Removed decorative section headers for lookup/state/constructor/properties/computed. |
| src/SharpClient.App/Platforms/MacCatalyst/Program.cs | Removed restatement “main entry point” comment. |
| src/SharpClient.App/Platforms/iOS/Program.cs | Removed restatement “main entry point” comment. |
| src/SharpClient.App/Platforms/Android/ConnectionKeepAliveService.cs | Removed decorative banners while retaining detailed rationale comments. |
| src/SharpClient.App/MauiProgram.cs | Removed decorative DI section headers while retaining explanatory comments. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
Codebase-wide comment sweep — lean comments, only where they explain something non-obvious.
What changed
Removed 105 lines across 18 files, comments/blanks only — zero code changes:
// ── Section ──banner separators (MauiProgram, ConnectionKeepAliveService, the ViewModels, WebProgram.cs, DI extensions, and test files'// ── Task N ──blocks).// This is the main entry point…).What was deliberately kept
Every "why" comment: telnet/keepalive/half-open rationale in
TelnetConnection, theconnectedDeviceforeground-service + Name-lockstep notes, EF two-round-trip and FTS5 rationale, DI ordering, ANSI/MXP parsing quirks,// key into ISecretStore, NOT the secret, etc. Two whole slices (CoreConnection/Sessions, CoreDomain/Persistence/Platform/Diagnostics) were already lean and untouched.Verification
Done as six parallel per-directory passes with identical strict rules (cut decoration + restatement; bias to keep any rationale).
🤖 Generated with Claude Code
https://claude.ai/code/session_01HHCRc5CJ6595iMzEgYYdQp