2.x: Update Mathematical and Aggregate Operators docs #6140
Conversation
Codecov Report
@@ Coverage Diff @@
## 2.x #6140 +/- ##
============================================
+ Coverage 98.19% 98.27% +0.08%
Complexity 6195 6195
============================================
Files 667 667
Lines 44853 44853
Branches 6213 6213
============================================
+ Hits 44043 44081 +38
+ Misses 259 235 -24
+ Partials 551 537 -14
Continue to review full report at Codecov.
|
| This page shows operators that perform mathematical or other operations over an entire sequence of items emitted by an `Observable`. Because these operations must wait for the source `Observable` to complete emitting items before they can construct their own emissions (and must usually buffer these items), these operators are dangerous to use on `Observable`s that may have very long or infinite sequences. |
|
|
||
| > The operators in this section are part of the [`RxJava2Extensions`](https://github.com/akarnokd/RxJava2Extensions) project. You have to add the `rxjava2-extensions` module as a dependency to your project. It can be found at [http://search.maven.org](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.github.akarnokd%22). | ||
|
|
There was a problem hiding this comment.
For clarity, you could include the import here:
import hu.akarnokd.rxjava2.math.MathObservable`;
import hu.akarnokd.rxjava2.math.MathFlowable`;There was a problem hiding this comment.
Also you can add the following additional note.
"Note that unlike the standard RxJava aggregator operators, these mathematical operators return Observable and Flowable instead of the Single or Maybe."
| ``` | ||
|
|
||
| ## Other Aggregate Operators |
|
|
||
| ## Other Aggregate Operators | ||
|
|
There was a problem hiding this comment.
A note on the return type would be great here:
"Note that these standard aggregate operators return a Single or Maybe because the number of output items is always know to be at most one."
| ``` | ||
|
|
||
| ### toList and toSortedList |
There was a problem hiding this comment.
Please split these into their own section.
| ``` | ||
|
|
||
| ### collect and collectInto |
There was a problem hiding this comment.
Please split these into their own section.
| ``` | ||
|
|
||
| ### reduce and reduceWith |
There was a problem hiding this comment.
Please split these into their own section.
This PR updates the
Mathematical-and-Aggregate-Operators.mdwiki page as per issue #6132:The page now follows the structure that was defined in #6131.
Question: Should Available in in the Mathematical Operators section be renamed to something else (e.g. Defined for), because the operators are not part of the core RxJava operators?