-
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
Fix terminology of cancel/dispose in the JavaDocs #6199
Fix terminology of cancel/dispose in the JavaDocs #6199
Conversation
…or Completable.
Codecov Report
@@ 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
Continue to review full report at Codecov.
|
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.
One small adjustment and its good to go.
@@ -432,7 +432,7 @@ public static Completable fromCallable(final Callable<?> callable) { | |||
* <p> | |||
* <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. |
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.
"Note that if any of the observers to this Completable call dispose,"
…e.fromFuture()` JavaDoc
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:
Flowable
,Publisher
, or aFuture
test()
methods where theTestObserver
returned actually has acancel()
method