chore(comments): remove pure-noise section banners (~30 lines)#107
Merged
Conversation
CLAUDE.md comment rule: 'If deleting the comment wouldn't confuse a future reader, it shouldn't have been there.' Audit pass over the cross-app dashboard controllers and the SDK Models.cs surface a collection of section-header banners that say nothing the class names + IDE folding don't already cover. Removed: - DashboardMessagesController: 1 banner (Messages) - DashboardAnalyticsController: 1 banner (Helper) - DashboardEndpointController: 3 banners (Endpoints, Payload Transformation, Event Types) - WebhookEngine.Sdk/Models.cs: 5 banner pairs (Response envelope, Event Types, Endpoints, Messages, Common query parameters) Preserved: - Test-file section markers (// ── Read paths ──, // ── Plumbing ──, etc.) — these correlate with [Fact] groupings inside the test classes and aid scanning when a single class hosts 30+ tests. - Portal controller / portal middleware section markers — same reasoning as the test files. Behaviour unchanged. Pure cosmetics; build + tests green.
voyvodka
added
documentation
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.
Summary
Tur 6b — closes the second of the two pre-B1 backlog items from
.planning/TODO.md. User-approved scope was 'pure noise only' (option A from the cleanup envelope); section-titled banners stay.CLAUDE.md comment rule: "If deleting the comment wouldn't confuse a future reader, it shouldn't have been there." This pass clears banners that say nothing the class names + IDE folding don't already cover.
Removed
src/WebhookEngine.API/Controllers/DashboardMessagesController.cssrc/WebhookEngine.API/Controllers/DashboardAnalyticsController.cssrc/WebhookEngine.API/Controllers/DashboardEndpointController.cssrc/WebhookEngine.Sdk/Models.csTotal: 40 lines removed, 0 added.
Preserved (deliberately)
// ── Read paths ──/// ── Write paths ──/// ── Plumbing ──/// ── Capability gating ──/// ── Cross-tenant guard ──markers inside the test files. These correlate with[Fact]groupings and aid scanning when a single class hosts 30+ tests — they earn their keep.// ── Endpoints ──/// ── Event types (read-only dropdown source) ──markers insidePortalEndpointsController— same reasoning.Behaviour
Pure cosmetics. Build green, all tests pass.
Test plan
dotnet build WebhookEngine.sln --configuration Release— 0 warnings, 0 errors.