Corrected buffer operator onError behaviour documentation #3561
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -3285,8 +3285,9 @@ public final Boolean call(T first, T second) { | |||
| /** | |||
| * Returns an Observable that emits buffers of items it collects from the source Observable. The resulting | |||
| * Observable emits connected, non-overlapping buffers, each containing {@code count} items. When the source | |||
| * Observable completes or encounters an error, the resulting Observable emits the current buffer and | |||
| * propagates the notification from the source Observable. | |||
| * Observable completes, the current buffer is emitted, and the event is propagated to all subscribed | |||
There was a problem hiding this comment.
I don't like "propagate to all subscribed Observers". It suggests this is some hot operation and data is shared (such as in publish()).
|
Applied @akarnokd suggestion. |
|
👍 |
|
👍 |
akarnokd
added a commit
that referenced
this pull request
Dec 8, 2015
Corrected buffer operator onError behaviour documentation
adamsp
added a commit
to adamsp/RxJava
that referenced
this pull request
Mar 7, 2018
The operator does not emit the buffer in case of error. Suspect these docs were copied over to 2.x before the fix from ReactiveX#3561 was merged.
akarnokd
pushed a commit
that referenced
this pull request
Mar 7, 2018
…5895) * Corrected documentation for buffer onError behaviour The operator does not emit the buffer in case of error. Suspect these docs were copied over to 2.x before the fix from #3561 was merged. * Corrected documentation for Flowable.buffer onError behaviour * Update boundary buffer documentation to change source -> supplied The word 'source' is incorrect here, since the buffer is emitted whenever the supplied Publisher emits an item
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
#3560