Skip to content

Fix terminology of cancel/dispose in the JavaDocs #6199

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.

Sign up for GitHub

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

Jump to bottom
Merged
akarnokd merged 5 commits into from
Sep 4, 2018
Merged

Fix terminology of cancel/dispose in the JavaDocs #6199

akarnokd merged 5 commits into from
Sep 4, 2018

Conversation

@luis-cortes
Copy link
Contributor

@luis-cortes luis-cortes commented Sep 3, 2018

Resolves #6196

Changing terminology from cancel -> dispose wherever appropriate in the following classes:

  • Observable.java
  • Single.java
  • Maybe.java
  • Completable.java

Areas where I did not change from cancel -> disposal include:

  • where the cancellation was in reference to a Flowable, Publisher, or a Future
  • test() methods where the TestObserver returned actually has a cancel() method

@codecov
Copy link

codecov bot commented Sep 3, 2018 •
edited
Loading

Codecov Report

Merging #6199 into 2.x will increase coverage by 0.02%.
The diff coverage is 100%.

Impacted file tree graph

@@             Coverage Diff              @@
##                2.x    #6199      +/-   ##
============================================
+ Coverage     98.23%   98.25%   +0.02%     
+ Complexity     6202     6201       -1     
============================================
  Files           667      667              
  Lines         44888    44888              
  Branches       6218     6218              
============================================
+ Hits          44095    44106      +11     
+ Misses          253      245       -8     
+ Partials        540      537       -3
Impacted Files Coverage Δ Complexity Δ
src/main/java/io/reactivex/Single.java 100% <ø> (ø) 146 <0> (ø) ⬇️
src/main/java/io/reactivex/Completable.java 100% <100%> (ø) 117 <2> (ø) ⬇️
src/main/java/io/reactivex/Observable.java 100% <100%> (ø) 541 <0> (ø) ⬇️
src/main/java/io/reactivex/Maybe.java 100% <100%> (ø) 171 <4> (ø) ⬇️
...reactivex/internal/operators/single/SingleAmb.java 96.36% <0%> (-3.64%) 9% <0%> (-1%)
...ernal/operators/flowable/FlowableFromIterable.java 94.11% <0%> (-2.14%) 5% <0%> (ø)
.../internal/disposables/ListCompositeDisposable.java 98% <0%> (-2%) 34% <0%> (-1%)
...rnal/operators/observable/ObservableSwitchMap.java 95.21% <0%> (-1.07%) 3% <0%> (ø)
...perators/mixed/ObservableSwitchMapCompletable.java 98.94% <0%> (-1.06%) 3% <0%> (ø)
...perators/observable/ObservableMergeWithSingle.java 99.06% <0%> (-0.94%) 2% <0%> (ø)
... and 18 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 e0532b7...2eaba8a. Read the comment docs.

@akarnokd akarnokd added this to the 2.2 backlog milestone Sep 4, 2018
akarnokd
akarnokd reviewed Sep 4, 2018
View reviewed changes
Copy link
Member

@akarnokd akarnokd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One small adjustment and its good to go.

src/main/java/io/reactivex/Completable.java Outdated
* <img width="640" height="628" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.fromFuture.png" alt="">
* <p>
* Note that cancellation from any of the subscribers to this Completable will cancel the future.
* Note that if any of the subscribers to this Completable call dispose, this Completable will cancel the future.
Copy link
Member

@akarnokd akarnokd Sep 4, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Note that if any of the observers to this Completable call dispose,"

@akarnokd akarnokd merged commit 59454ea into ReactiveX:2.x Sep 4, 2018
@luis-cortes luis-cortes deleted the remove-cancellation-language-from-non-cancellable-types branch September 4, 2018 16:08
@akarnokd akarnokd mentioned this pull request Sep 4, 2018
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@akarnokd akarnokd akarnokd approved these changes

+1 more reviewer

@vanniktech vanniktech vanniktech approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

2.x Documentation

Projects

None yet

Milestone

2.2 backlog

Development

Successfully merging this pull request may close these issues.

3 participants

@luis-cortes @akarnokd @vanniktech