Skip to content

Commit fdb9605

Browse files
gnpricechrisbobbe
authored andcommitted
store [nfc]: Update comments for UpdateMachine replacing LivePerAccountStore
This change happened in 5c778bd, but some comments didn't get updated at the same time, oops.
1 parent f3de9a0 commit fdb9605

File tree

1 file changed

+5
-9
lines changed

1 file changed

+5
-9
lines changed

lib/model/store.dart

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -140,14 +140,10 @@ abstract class GlobalStore extends ChangeNotifier {
140140
/// This should always have a consistent snapshot of the state on the server,
141141
/// as provided by the Zulip event system.
142142
///
143-
/// An instance directly of this class will not attempt to poll an event queue
144-
/// to keep the data up to date. For that behavior, see the subclass
145-
/// [LivePerAccountStore].
143+
/// This class does not attempt to poll an event queue
144+
/// to keep the data up to date. For that behavior, see
145+
/// [UpdateMachine].
146146
class PerAccountStore extends ChangeNotifier with StreamStore {
147-
/// Create a per-account data store that does not automatically stay up to date.
148-
///
149-
/// For a [PerAccountStore] that polls an event queue to keep itself up to
150-
/// date, use [LivePerAccountStore.fromInitialSnapshot].
151147
factory PerAccountStore.fromInitialSnapshot({
152148
required Account account,
153149
required ApiConnection connection,
@@ -410,8 +406,8 @@ const _apiSendMessage = sendMessage; // Bit ugly; for alternatives, see: https:/
410406
/// The underlying data store is an [AppDatabase] corresponding to a SQLite
411407
/// database file in the app's persistent storage on the device.
412408
///
413-
/// The per-account stores will be instances of [LivePerAccountStore],
414-
/// with data loaded through a live [ApiConnection].
409+
/// The per-account stores will use a live [ApiConnection],
410+
/// and will have an associated [UpdateMachine].
415411
class LiveGlobalStore extends GlobalStore {
416412
LiveGlobalStore._({
417413
required AppDatabase db,

0 commit comments

Comments
 (0)