Skip to content

unreads [nfc]: Update dartdoc following stream/topic-muting logic #624

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 26, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 3 additions & 7 deletions lib/model/unreads.dart
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,10 @@ import 'stream.dart';
///
/// Implemented to track actual unread state as faithfully as possible
/// given incomplete information in [UnreadMessagesSnapshot].
/// Callers should do their own filtering based on other state, like muting,
/// as desired.
///
/// In each component of this model ([streams], [dms], [mentions]),
/// if a message is not represented, its status is either read
/// or unknown to the component. In all components,
/// a message's status will be unknown if, at /register time,
/// it was very old by the server's reckoning. See [oldUnreadsMissing].
/// In [streams], [dms], and [mentions], if a message is not represented,
/// its status is either read or unknown. A message's status will be unknown if
/// it was very old at /register time; see [oldUnreadsMissing].
/// In [mentions], there's another more complex reason
/// the state might be unknown; see there.
///
Expand Down
Loading