Skip to content

docs(realtime, supabase_flutter): add class-level dartdoc to RealtimeClient and SupabaseAuth#1344

Merged
grdsdev merged 3 commits intomainfrom
grdsdev/sdk-816-realtime-class-docs
Apr 7, 2026
Merged

docs(realtime, supabase_flutter): add class-level dartdoc to RealtimeClient and SupabaseAuth#1344
grdsdev merged 3 commits intomainfrom
grdsdev/sdk-816-realtime-class-docs

Conversation

@grdsdev
Copy link
Copy Markdown
Contributor

@grdsdev grdsdev commented Apr 2, 2026

Adds meaningful class-level dartdoc to two of the most complex classes in the SDK, replacing missing or trivial comments.

RealtimeClient now documents its WebSocket lifecycle ownership, heartbeating, channel multiplexing, token refresh, and key collaborators. SupabaseAuth replaces the bare /// SupabaseAuth stub with documentation covering its Flutter lifecycle integration, session persistence, deep link handling, and PKCE/Implicit flow support.

Closes SDK-816.

grdsdev and others added 2 commits April 2, 2026 14:19
…altimeClient and SupabaseAuth

Covers responsibility, key collaborators, lifecycle, and platform notes
for both classes as specified in SDK-816.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…altimeClient and SupabaseAuth

Covers responsibility, key collaborators, lifecycle, and platform notes
for both classes as specified in SDK-816.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Comment thread packages/supabase_flutter/lib/src/supabase_auth.dart Outdated
Comment thread packages/supabase_flutter/lib/src/supabase_auth.dart Outdated
Comment thread packages/supabase_flutter/lib/src/supabase_auth.dart Outdated
…rtdoc

- Use [GoTrueClient] link instead of backtick code span
- Use [AuthChangeEvent.initialSession] for enum reference
- Remove Platform.isIOS/isAndroid note (not useful to callers)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@grdsdev grdsdev requested a review from Vinzent03 April 6, 2026 10:30
@grdsdev grdsdev merged commit b662dfd into main Apr 7, 2026
15 checks passed
@grdsdev grdsdev deleted the grdsdev/sdk-816-realtime-class-docs branch April 7, 2026 18:27
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.

3 participants