Skip to content
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: update javadoc of flatMap() overloads #5127

Merged
merged 1 commit into from
Feb 22, 2017

Conversation

akarnokd
Copy link
Member

This PR rewords the Javadoc of Flowable.flatMap() overloads to correctly express their behavior regarding backpressure towards their upstream. In 2.x, only merge() operators are unbounded-in by default, flatMaps are by default bounded by bufferSize() or the maxConcurrency parameter.

In addition, one of the flatMap overload still had resultSelector instead of the common combiner parameter name. As far as I know, there are no language-specific libraries targeting 2.x yet where in the language the actual parameter names are also part of the signature and changing them counts as an incompatible change.

Related #5126.

@akarnokd akarnokd added this to the 2.0 backlog milestone Feb 22, 2017
@codecov
Copy link

codecov bot commented Feb 22, 2017

Codecov Report

Merging #5127 into 2.x will decrease coverage by -0.07%.
The diff coverage is 100%.

@@             Coverage Diff              @@
##                2.x    #5127      +/-   ##
============================================
- Coverage     95.93%   95.87%   -0.07%     
+ Complexity     5605     5601       -4     
============================================
  Files           620      620              
  Lines         39810    39810              
  Branches       5597     5597              
============================================
- Hits          38191    38167      -24     
- Misses          637      661      +24     
  Partials        982      982
Impacted Files Coverage Δ Complexity Δ
src/main/java/io/reactivex/Flowable.java 100% <100%> (ø) 522 <1> (ø)
...rnal/subscriptions/ArrayCompositeSubscription.java 93.33% <ø> (-6.67%) 17% <ø> (-1%)
...vex/internal/operators/single/SingleTakeUntil.java 88.52% <ø> (-6.56%) 2% <ø> (ø)
.../internal/operators/maybe/MaybeTakeUntilMaybe.java 93.87% <ø> (-6.13%) 2% <ø> (ø)
...in/java/io/reactivex/subjects/BehaviorSubject.java 83.93% <ø> (-5.7%) 55% <ø> (ø)
...ava/io/reactivex/processors/BehaviorProcessor.java 86.44% <ø> (-5.15%) 55% <ø> (ø)
...rnal/subscribers/SinglePostCompleteSubscriber.java 94.87% <ø> (-5.13%) 14% <ø> (-1%)
...rnal/subscriptions/DeferredScalarSubscription.java 93.84% <ø> (-4.62%) 27% <ø> (-1%)
.../main/java/io/reactivex/subjects/MaybeSubject.java 95.65% <ø> (-4.35%) 46% <ø> (-2%)
...vex/internal/operators/flowable/FlowableTimer.java 92.85% <ø> (-3.58%) 2% <ø> (ø)
... and 38 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 70922a6...abbd670. Read the comment docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants