Skip to content

3.x: Flowable scan/scanWith backpressure documentation update #7110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 12, 2020
Merged

3.x: Flowable scan/scanWith backpressure documentation update #7110

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5c2b102
3.x: Flowable scan/scanWith backpressure documentation update
fsbarata Nov 12, 2020
e416b6f
3.x: Flowable scan/scanWith backpressure documentation merge <dd> sec…
fsbarata Nov 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions src/main/java/io/reactivex/rxjava3/core/Flowable.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14735,7 +14735,9 @@ public final Flowable<T> scan(@NonNull BiFunction<T, T, T> accumulator) {
* <dl>
* <dt><b>Backpressure:</b></dt>
* <dd>The operator honors downstream backpressure and expects the current {@code Flowable} to honor backpressure as well.
* Violating this expectation, a {@link MissingBackpressureException} <em>may</em> get signaled somewhere downstream.</dd>
* Violating this expectation, a {@link MissingBackpressureException} <em>may</em> get signaled somewhere downstream.
* The downstream request pattern is not preserved across this operator.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You don't have to start a new <dd> here, just add the text on a new line inside the previous <dd>.

Copy link
Contributor Author

@fsbarata fsbarata Nov 12, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • merge <dd> sections

* The upstream is requested {@link #bufferSize()} - 1 upfront and 75% of {@link #bufferSize()} thereafter.</dd>
* <dt><b>Scheduler:</b></dt>
* <dd>{@code scan} does not operate by default on a particular {@link Scheduler}.</dd>
* </dl>
Expand Down Expand Up @@ -14774,7 +14776,9 @@ public final Flowable<T> scan(@NonNull BiFunction<T, T, T> accumulator) {
* <dl>
* <dt><b>Backpressure:</b></dt>
* <dd>The operator honors downstream backpressure and expects the current {@code Flowable} to honor backpressure as well.
* Violating this expectation, a {@link MissingBackpressureException} <em>may</em> get signaled somewhere downstream.</dd>
* Violating this expectation, a {@link MissingBackpressureException} <em>may</em> get signaled somewhere downstream.
* The downstream request pattern is not preserved across this operator.
* The upstream is requested {@link #bufferSize()} - 1 upfront and 75% of {@link #bufferSize()} thereafter.</dd>
* <dt><b>Scheduler:</b></dt>
* <dd>{@code scanWith} does not operate by default on a particular {@link Scheduler}.</dd>
* </dl>
Expand Down