Add "error handling" java docs section to from callable & co #6193
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 2 commits
September 1, 2018 21:18
…ble(), Single#fromCallable(), and Completable#fromCallable().
…nd Completable#fromAction().
Codecov Report
@@ Coverage Diff @@
## 2.x #6193 +/- ##
============================================
- Coverage 98.22% 98.21% -0.02%
- Complexity 6197 6199 +2
============================================
Files 667 667
Lines 44888 44888
Branches 6218 6218
============================================
- Hits 44091 44086 -5
- Misses 253 259 +6
+ Partials 544 543 -1
Continue to review full report at Codecov.
|
akarnokd
reviewed
Sep 2, 2018
| * <dt><b>Error handling:</b></dt> | ||
| * <dd> If the {@link Action} throws an exception, the respective {@link Throwable} is | ||
| * delivered to the downstream via {@link CompletableObserver#onError(Throwable)}, | ||
| * except when the downstream has canceled or disposed this {@code Completable} source. |
There was a problem hiding this comment.
"downstream has disposed this" as only Flowables have cancel.
| * <dt><b>Error handling:</b></dt> | ||
| * <dd> If the {@link Callable} throws an exception, the respective {@link Throwable} is | ||
| * delivered to the downstream via {@link CompletableObserver#onError(Throwable)}, | ||
| * except when the downstream has canceled or disposed this {@code Completable} source. |
| * <dt><b>Error handling:</b></dt> | ||
| * <dd> If the {@link Action} throws an exception, the respective {@link Throwable} is | ||
| * delivered to the downstream via {@link MaybeObserver#onError(Throwable)}, | ||
| * except when the downstream has canceled or disposed this {@code Maybe} source. |
| * <dt><b>Error handling:</b></dt> | ||
| * <dd> If the {@link Callable} throws an exception, the respective {@link Throwable} is | ||
| * delivered to the downstream via {@link Observer#onError(Throwable)}, | ||
| * except when the downstream has canceled or disposed this {@code Observable} source. |
| * <dt><b>Error handling:</b></dt> | ||
| * <dd> If the {@link Callable} throws an exception, the respective {@link Throwable} is | ||
| * delivered to the downstream via {@link SingleObserver#onError(Throwable)}, | ||
| * except when the downstream has canceled or disposed this {@code Single} source. |
added 2 commits
September 2, 2018 08:38
akarnokd
approved these changes
Sep 2, 2018
|
I noticed that there's quite a bit more of the "cancellation" language in the other areas.
Should this be added to #4535? |
|
Post a separate PR for those. |
|
Should I create a separate issue as well? Also, is there anything else you need from me to get this PR merged (unsure of the process at this point)? |
|
No need to open an issue for that. We are waiting for another approval and this will be merged. |
luis-cortes
deleted the
Add-"Error-handling"-JavaDocs-section-to-fromCallable-&-co
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #6179
Added JavaDocs describing the regular and canceled/disposed behavior for
Observable.fromCallable()Single.fromCallable()Maybe.fromAction()Completable.fromCallable()Completable.fromAction()Flowable.fromCallable()Did not alter
Maybe.fromCallable()because the existing JavaDoc appears to be adequate.