Skip to content

Commit fcd74e6

Browse files
chrisbobbegnprice
authored andcommitted
unreads [nfc]: Update dartdoc following stream/topic-muting logic
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.
1 parent 449a478 commit fcd74e6

File tree

1 file changed

+3
-7
lines changed

1 file changed

+3
-7
lines changed

lib/model/unreads.dart

+3-7
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,10 @@ import 'stream.dart';
1515
///
1616
/// Implemented to track actual unread state as faithfully as possible
1717
/// given incomplete information in [UnreadMessagesSnapshot].
18-
/// Callers should do their own filtering based on other state, like muting,
19-
/// as desired.
2018
///
21-
/// In each component of this model ([streams], [dms], [mentions]),
22-
/// if a message is not represented, its status is either read
23-
/// or unknown to the component. In all components,
24-
/// a message's status will be unknown if, at /register time,
25-
/// it was very old by the server's reckoning. See [oldUnreadsMissing].
19+
/// In [streams], [dms], and [mentions], if a message is not represented,
20+
/// its status is either read or unknown. A message's status will be unknown if
21+
/// it was very old at /register time; see [oldUnreadsMissing].
2622
/// In [mentions], there's another more complex reason
2723
/// the state might be unknown; see there.
2824
///

0 commit comments

Comments
 (0)