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

Improve doOnDispose JavaDoc #5296

Merged
merged 3 commits into from
Apr 19, 2017
Merged

Conversation

Mauin
Copy link
Contributor

@Mauin Mauin commented Apr 19, 2017

Sorry for the earlier PR #5295... :/

This addresses the JavaDoc issues discussed in #5283.

  • Removes the Note in Observable.doOnDispose which claims its action would be called on terminal events.
  • Slightly adjusts the JavaDocs of the Maybe/Single/Completable variants.
  • Adds @throws note to some Observable/Single/Maybe .doOnDispose as it was present in the Completable variant.

The note was claiming Observable.doOnDispose() would be called for
terminal events of the Observable, which is not the case
@akarnokd akarnokd added this to the 2.0 backlog milestone Apr 19, 2017
@akarnokd akarnokd merged commit 67a951b into ReactiveX:2.x Apr 19, 2017
@codecov
Copy link

codecov bot commented Apr 19, 2017

Codecov Report

Merging #5296 into 2.x will increase coverage by 0.15%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff              @@
##                2.x    #5296      +/-   ##
============================================
+ Coverage     96.11%   96.26%   +0.15%     
- Complexity     5750     5767      +17     
============================================
  Files           628      628              
  Lines         41085    41085              
  Branches       5703     5703              
============================================
+ Hits          39487    39551      +64     
+ Misses          634      600      -34     
+ Partials        964      934      -30
Impacted Files Coverage Δ Complexity Δ
src/main/java/io/reactivex/Observable.java 100% <ø> (ø) 506 <0> (ø) ⬇️
src/main/java/io/reactivex/Completable.java 100% <ø> (ø) 112 <0> (ø) ⬇️
src/main/java/io/reactivex/Single.java 99.32% <ø> (ø) 131 <0> (ø) ⬇️
src/main/java/io/reactivex/Maybe.java 100% <ø> (ø) 168 <0> (ø) ⬇️
...vex/internal/operators/flowable/FlowableTimer.java 92.85% <0%> (-3.58%) 2% <0%> (ø)
...x/internal/operators/maybe/MaybeSwitchIfEmpty.java 97.22% <0%> (-2.78%) 2% <0%> (ø)
...vex/internal/operators/flowable/FlowableCache.java 92.61% <0%> (-2.69%) 7% <0%> (ø)
...al/operators/observable/ObservableSampleTimed.java 96.66% <0%> (-1.67%) 3% <0%> (ø)
.../operators/observable/ObservableFlatMapSingle.java 95.52% <0%> (-0.75%) 2% <0%> (ø)
...ternal/operators/observable/ObservableFlatMap.java 82.89% <0%> (-0.66%) 3% <0%> (ø)
... and 33 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 5ab2083...6c6c8f4. 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.

2 participants