Skip to content

Commit 78b29f7

Browse files
authored
3.x: Flowable scan/scanWith backpressure documentation update (#7110)
* 3.x: Flowable scan/scanWith backpressure documentation update Documented Flowable initial value scan variants upstream consumption pattern as it is different from the variant with no initial value. * 3.x: Flowable scan/scanWith backpressure documentation merge <dd> sections
1 parent 57fd72e commit 78b29f7

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

src/main/java/io/reactivex/rxjava3/core/Flowable.java

+6-2
Original file line numberDiff line numberDiff line change
@@ -14735,7 +14735,9 @@ public final Flowable<T> scan(@NonNull BiFunction<T, T, T> accumulator) {
1473514735
* <dl>
1473614736
* <dt><b>Backpressure:</b></dt>
1473714737
* <dd>The operator honors downstream backpressure and expects the current {@code Flowable} to honor backpressure as well.
14738-
* Violating this expectation, a {@link MissingBackpressureException} <em>may</em> get signaled somewhere downstream.</dd>
14738+
* Violating this expectation, a {@link MissingBackpressureException} <em>may</em> get signaled somewhere downstream.
14739+
* The downstream request pattern is not preserved across this operator.
14740+
* The upstream is requested {@link #bufferSize()} - 1 upfront and 75% of {@link #bufferSize()} thereafter.</dd>
1473914741
* <dt><b>Scheduler:</b></dt>
1474014742
* <dd>{@code scan} does not operate by default on a particular {@link Scheduler}.</dd>
1474114743
* </dl>
@@ -14774,7 +14776,9 @@ public final Flowable<T> scan(@NonNull BiFunction<T, T, T> accumulator) {
1477414776
* <dl>
1477514777
* <dt><b>Backpressure:</b></dt>
1477614778
* <dd>The operator honors downstream backpressure and expects the current {@code Flowable} to honor backpressure as well.
14777-
* Violating this expectation, a {@link MissingBackpressureException} <em>may</em> get signaled somewhere downstream.</dd>
14779+
* Violating this expectation, a {@link MissingBackpressureException} <em>may</em> get signaled somewhere downstream.
14780+
* The downstream request pattern is not preserved across this operator.
14781+
* The upstream is requested {@link #bufferSize()} - 1 upfront and 75% of {@link #bufferSize()} thereafter.</dd>
1477814782
* <dt><b>Scheduler:</b></dt>
1477914783
* <dd>{@code scanWith} does not operate by default on a particular {@link Scheduler}.</dd>
1478014784
* </dl>

0 commit comments

Comments
 (0)