-
Notifications
You must be signed in to change notification settings - Fork 7.6k
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.
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
2.x: Add finite requirement to various collector operators JavaDoc #5856
Conversation
Codecov Report
@@ Coverage Diff @@
## 2.x #5856 +/- ##
===========================================
+ Coverage 96.4% 96.49% +0.08%
- Complexity 5834 5838 +4
===========================================
Files 640 640
Lines 41944 41944
Branches 5804 5804
===========================================
+ Hits 40438 40474 +36
+ Misses 582 570 -12
+ Partials 924 900 -24
Continue to review full report at Codecov.
|
078f5de
to
444b9a5
Compare
* <p> | ||
* Note that this operator requires the upstream to signal {@code onComplete} for the accumulator to | ||
* be emitted. Sources that are infinite and never complete will never emit anything through this | ||
* operator and an infinite source may lead to a fatal {@code OutOfMemoryError}. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nice addition!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor grammar nit
* a Single that emits this structure. | ||
* <p> | ||
* <img width="640" height="330" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/collect.png" alt=""> | ||
* <p> | ||
* This is a simplified version of {@code reduce} that does not need to return the state on each pass. | ||
* <p> | ||
* Note that this operator requires the upstream to signal {@code onComplete} for the accumulator to | ||
* be emitted. Sources that are infinite and never complete will never emit anything through this |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"accumulator to emit" or "accumulation to be emitted" or "accumulated object to be emitted". There are other occurrences of this in the PR.
Add notes to the following operators to state their sources has to be finite. It has been already done to
toList
in #5465.collect
collectInto
reduce
reduceWith
toMap
toMultimap
toSortedList