Skip to content

Commit

Permalink
unreads [nfc]: Update dartdoc following stream/topic-muting logic
Browse files Browse the repository at this point in the history
In zulip#423 "Implement stream and topic muting", the Unreads class did
start doing some filtering based in stream/topic muting,
specifically in these methods:
- countInStream
- countInAllMessagesNarrow

So, update the dartdoc so it doesn't claim that this filtering is an
entirely separate concern.
  • Loading branch information
chrisbobbe authored and gnprice committed Apr 26, 2024
1 parent 449a478 commit fcd74e6
Showing 1 changed file with 3 additions and 7 deletions.
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

0 comments on commit fcd74e6

Please sign in to comment.