PR feedback

bitwarden · Aug 1, 2024 · 349b837 · 349b837
1 parent a00c9ca
commit 349b837
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/app/src/main/java/com/x8bit/bitwarden/ui/platform/base/util/BackgroundEvent.kt b/app/src/main/java/com/x8bit/bitwarden/ui/platform/base/util/BackgroundEvent.kt
@@ -3,6 +3,6 @@ package com.x8bit.bitwarden.ui.platform.base.util
 /**
  * Almost all the events in the app involve navigation or toasts. To prevent accidentally
  * navigating to the same view twice, by default, events are ignored if the view is not currently
- * resumed. To avoid that restriction, specific events can conform to [BackgroundEvent].
+ * resumed. To avoid that restriction, specific events can implement [BackgroundEvent].
  */
 interface BackgroundEvent
diff --git a/app/src/main/java/com/x8bit/bitwarden/ui/platform/base/util/EventsEffect.kt b/app/src/main/java/com/x8bit/bitwarden/ui/platform/base/util/EventsEffect.kt
@@ -11,6 +11,10 @@ import kotlinx.coroutines.flow.onEach
 
 /**
  * Convenience method for observing event flow from [BaseViewModel].
+ *
+ * By default, events will only be consumed when the associated screen is
+ * resumed, to avoid bugs like duplicate navigation calls. To override
+ * this behavior, a given event type can implement [BackgroundEvent].
  */
 @Composable
 fun <E> EventsEffect(