Skip to content

Commit 4e17e01

Browse files
committed
docs: fix stale references in AGENTS.md and auth_repository doc comment
1 parent 20be2a7 commit 4e17e01

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ MVVM pattern with Riverpod for DI and reactive state (manual providers, no codeg
171171

172172
**Re-auth Coalescing:** `AuthRepository._reauthenticate` uses the same `Completer` pattern — first caller triggers login, concurrent callers await the same future. Prevents redundant login attempts when multiple `withAuth` calls detect session expiry simultaneously.
173173

174-
**Session Lifecycle:** `sessionProvider` (`Notifier<bool>`) drives auth state. `true` = authenticated, `false` = unauthenticated. Router guard watches it for redirect. Repository providers `ref.watch(sessionProvider)` to be recreated with fresh state when the session ends. On auth failure, `withAuth` destroys the session and returns a never-completing `Completer<T>().future`callers never see auth errors, only `DioException` for network failures.
174+
**Session Lifecycle:** `sessionProvider` (`Notifier<bool>`) drives auth state. `true` = authenticated, `false` = unauthenticated. Router guard watches it for redirect. Repository providers `ref.watch(sessionProvider)` to be recreated with fresh state when the session ends. On auth failure, `withAuth` destroys the session and returns a never-completing `Completer<T>().future`session-scoped providers are already being disposed by the time callers would stall, so the hanging future is harmless. Callers only need to handle `DioException` for network failures.
175175

176176
**InvalidCookieFilter:** iSchool+ returns malformed cookies; custom interceptor filters them.
177177

lib/repositories/auth_repository.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -528,7 +528,7 @@ class AuthRepository {
528528
///
529529
/// Emits the most recent semester where the user is actively enrolled,
530530
/// or `null` if no active registration exists. Automatically re-emits
531-
/// when the underlying data changes (e.g., after [getUser] populates
531+
/// when the underlying data changes (e.g., after [refreshUser] populates
532532
/// registration data or after cache clear).
533533
Stream<UserRegistration?> watchActiveRegistration() {
534534
return (_database.select(_database.userRegistrations)

0 commit comments

Comments
 (0)