refactor: prune redundant comments that restate the code below them - #1852
Conversation
An audit of `//` comments across the SDK packages, removing ones that just restate the line or block immediately below them (mirrors supabase-swift#1367). No behavior change.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (10)
💤 Files with no reviewable changes (8)
Included review availability: Your plan provides up to 4 included reviews per hour; 2 remain after this review. 📝 WalkthroughWalkthroughThe change removes obsolete inline comments and updates two documentation comments across PostgREST, Auth, Flutter, Functions, Realtime, and Storage packages. Executable logic, public APIs, and control flow remain unchanged. ChangesSDK cleanup
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~5 minutes Change: Refactor Suggested reviewers: Merge Risk: ⚪ Minimal · up to This cleanup does not change SDK behavior, so no merge-blocking risk is identified. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Dartdocs describe current behavior; design history and tracking references belong in the PR/commit, not the doc comment.
What
An audit of
\//`` comments across the SDK packages for ones that just restate the line or block immediately below them, following the same pass done in supabase-swift#1367. No behavior change.Removed
supabase_auth/lib/src/helper.dart—// Decode header/// Decode payload/// Decode signatureindecodeJwtsupabase_auth/lib/src/auth_client.dart— restated comments in_fetchJwkandgetClaims, and a stale// Make a GET requestlabel on a callback that actually sends a POSTpostgrest/lib/src/postgrest_filter_builder.dart— bare// array/// jsonlabels already implied by the type checkpostgrest/lib/src/postgrest_transform_builder.dart— comment restating the block below inmaxAffectedsupabase_functions/lib/src/functions_client.dart— comment restating the map literal belowsupabase_storage/lib/src/fetch.dart— comments restatingcreateRequest()supabase_storage/lib/src/storage_client.dart— comments restating the legacy storage URL transform stepssupabase_flutter/lib/src/supabase.dart— comment duplicating the dartdoc already on_processLifecycleVerification
dart formatdart analyze— no issuesSummary by CodeRabbit