Skip to content

Commit a198f72

Browse files
gnpricechrisbobbe
authored andcommitted
actions [nfc]: Document remaining methods
Like the previous commit, this hopefully helps avoid confusion about the role of these methods when looking at their call sites.
1 parent 3017ba6 commit a198f72

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

lib/widgets/actions.dart

+10
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,11 @@ import 'store.dart';
1717
/// But they don't belong in `lib/api/`, because they also interact with widgets
1818
/// in order to present success or error feedback to the user through the UI.
1919
abstract final class ZulipAction {
20+
/// Mark the given narrow as read,
21+
/// showing feedback to the user on progress or failure.
22+
///
23+
/// This is mostly a wrapper around [updateMessageFlagsStartingFromAnchor];
24+
/// for details on the UI feedback, see there.
2025
static Future<void> markNarrowAsRead(BuildContext context, Narrow narrow) async {
2126
final store = PerAccountStoreWidget.of(context);
2227
final connection = store.connection;
@@ -63,6 +68,11 @@ abstract final class ZulipAction {
6368
}
6469
}
6570

71+
/// Mark the given narrow as unread from the given message onward,
72+
/// showing feedback to the user on progress or failure.
73+
///
74+
/// This is a wrapper around [updateMessageFlagsStartingFromAnchor];
75+
/// for details on the UI feedback, see there.
6676
static Future<void> markNarrowAsUnreadFromMessage(
6777
BuildContext context,
6878
Message message,

0 commit comments

Comments
 (0)