Documenation wording tweak

JakeWharton · Sep 13, 2019 · 1b6ad44 · 1b6ad44
1 parent 269c2aa
commit 1b6ad44
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/replaying-share-kotlin/src/main/kotlin/com/jakewharton/rx/ReplayingShare.kt b/replaying-share-kotlin/src/main/kotlin/com/jakewharton/rx/ReplayingShare.kt
@@ -26,7 +26,8 @@ import io.reactivex.Observable
  * This allows expensive upstream observables to be shut down when no one is observing while also
  * replaying the last value seen by *any* observer to new ones.
  *
- * @param defaultValue the initial value to be cached
+ * @param defaultValue the initial value delivered to new subscribers before any events are cached.
+ * A null value means there will be no initial emission.
  */
 @JvmOverloads
 fun <T> Observable<T>.replayingShare(defaultValue: T? = null): Observable<T> {
@@ -44,7 +45,8 @@ fun <T> Observable<T>.replayingShare(defaultValue: T? = null): Observable<T> {
  * This allows expensive upstream flowables to be shut down when no one is subscribed while also
  * replaying the last value seen by *any* subscriber to new ones.
  *
- * @param defaultValue the initial value to be cached
+ * @param defaultValue the initial value delivered to new subscribers before any events are cached.
+ * A null value means there will be no initial emission.
  */
 @JvmOverloads
 fun <T> Flowable<T>.replayingShare(defaultValue: T? = null): Flowable<T> {

diff --git a/replaying-share/src/main/java/com/jakewharton/rx/ReplayingShare.java b/replaying-share/src/main/java/com/jakewharton/rx/ReplayingShare.java
@@ -50,7 +50,8 @@ public static <T> ReplayingShare<T> instance() {
    * Creates a `ReplayingShare` transformer with a default value which will be emitted downstream
    * on subscription if there is not any cached value yet.
    *
-   * @param defaultValue the initial value, cannot be null
+   * @param defaultValue the initial value delivered to new subscribers before any events are
+   * cached.
    */
   @NonNull
   public static <T> ReplayingShare<T> createWithDefault(@NonNull T defaultValue) {