Add a better comment (#213)

airbnb · Mar 20, 2019 · 60afc38 · 60afc38
1 parent 2d7efa4
commit 60afc38
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/mvrx/src/main/kotlin/com/airbnb/mvrx/MvRxView.kt b/mvrx/src/main/kotlin/com/airbnb/mvrx/MvRxView.kt
@@ -45,7 +45,13 @@ interface MvRxView : MvRxViewModelStoreOwner, LifecycleOwner {
      * the fragment's lifecycle owner so that the subscriptions are cleared in `onDestroy`. Subscriptions made in or after
      * `onCreateView` should use the fragment's _view's_ lifecycle owner so that they are cleared in `onDestroyView`.
      *
-     * By default this is the same as the view's standard lifecycle owner.
+     * For example, if you are using a fragment as a MvRxView the proper implementation is:
+     * ```
+     *     override val subscriptionLifecycleOwner: LifecycleOwner
+     *        get() = this.viewLifecycleOwnerLiveData.value ?: this
+     * ```
+     *
+     * By default [subscriptionLifecycleOwner] is the same as the MvRxView's standard lifecycle owner.
      */
     val subscriptionLifecycleOwner : LifecycleOwner
         get() = this