Skip to content

refactor: prune redundant comments that restate the code below them - #1852

Merged
spydon merged 2 commits into
mainfrom
chore/prune-redundant-comments
Sep 18, 2026
Merged

spydon merged 2 commits into
mainfrom
chore/prune-redundant-comments

Conversation

@spydon

@spydon spydon commented Sep 17, 2026

Copy link
Copy Markdown
Contributor

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 signature in decodeJwt
  • supabase_auth/lib/src/auth_client.dart — restated comments in _fetchJwk and getClaims, and a stale // Make a GET request label on a callback that actually sends a POST
  • postgrest/lib/src/postgrest_filter_builder.dart — bare // array / // json labels already implied by the type check
  • postgrest/lib/src/postgrest_transform_builder.dart — comment restating the block below in maxAffected
  • supabase_functions/lib/src/functions_client.dart — comment restating the map literal below
  • supabase_storage/lib/src/fetch.dart — comments restating createRequest()
  • supabase_storage/lib/src/storage_client.dart — comments restating the legacy storage URL transform steps
  • supabase_flutter/lib/src/supabase.dart — comment duplicating the dartdoc already on _processLifecycle

Verification

  • dart format
  • dart analyze — no issues

Summary by CodeRabbit

  • Documentation
    • Clarified and streamlined internal code comments across authentication, database, storage, functions, realtime, and Flutter components.
    • Updated wording for shared preference storage documentation.
    • Improved timestamp formatting documentation by removing an outdated issue reference.
    • No user-facing functionality or public APIs were changed.

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.
@spydon
spydon requested a review from a team as a code owner September 17, 2026 16:42
@coderabbitai

coderabbitai Bot commented Sep 17, 2026

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: cc4e4b66-87d0-4e53-97d2-0e6557dccef3

📥 Commits

Reviewing files that changed from the base of the PR and between b63898e and 40f8b9a.

📒 Files selected for processing (10)
  • packages/postgrest/lib/src/postgrest_filter_builder.dart
  • packages/postgrest/lib/src/postgrest_transform_builder.dart
  • packages/supabase_auth/lib/src/auth_client.dart
  • packages/supabase_auth/lib/src/helper.dart
  • packages/supabase_flutter/lib/src/shared_preferences_auth_async_storage.dart
  • packages/supabase_flutter/lib/src/supabase.dart
  • packages/supabase_functions/lib/src/functions_client.dart
  • packages/supabase_realtime/lib/src/transformers.dart
  • packages/supabase_storage/lib/src/fetch.dart
  • packages/supabase_storage/lib/src/storage_client.dart
💤 Files with no reviewable changes (8)
  • packages/supabase_functions/lib/src/functions_client.dart
  • packages/supabase_auth/lib/src/auth_client.dart
  • packages/supabase_auth/lib/src/helper.dart
  • packages/supabase_storage/lib/src/storage_client.dart
  • packages/supabase_storage/lib/src/fetch.dart
  • packages/supabase_flutter/lib/src/supabase.dart
  • packages/postgrest/lib/src/postgrest_filter_builder.dart
  • packages/postgrest/lib/src/postgrest_transform_builder.dart

Included review availability: Your plan provides up to 4 included reviews per hour; 2 remain after this review.


📝 Walkthrough

Walkthrough

The 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.

Changes

SDK cleanup

Layer / File(s) Summary
Request handling comment cleanup
packages/postgrest/..., packages/supabase_functions/..., packages/supabase_storage/..., packages/postgrest/...
Redundant comments are removed from filter serialization, maxAffected, function invocation, multipart retries, and storage URL transformation.
Authentication comment cleanup
packages/supabase_auth/lib/src/auth_client.dart, packages/supabase_auth/lib/src/helper.dart
Comments around token refresh, JWKS lookup, claims validation, and JWT decoding are removed.
Client documentation cleanup
packages/supabase_flutter/..., packages/supabase_realtime/...
The _webItem documentation is reworded, the lifecycle comment is removed, and the timestamp documentation is corrected.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Refactor

Suggested reviewers: grdsdev, mandarini

Merge Risk: ⚪ Minimal · up to 40f8b

This cleanup does not change SDK behavior, so no merge-blocking risk is identified.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the primary change: removing redundant comments across the SDK. It matches the documented scope and behavior-preserving refactor.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Dartdocs describe current behavior; design history and tracking
references belong in the PR/commit, not the doc comment.
@spydon
spydon merged commit 465b18e into main Sep 18, 2026
44 checks passed
@spydon
spydon deleted the chore/prune-redundant-comments branch September 18, 2026 12:02
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.

2 participants