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.

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

Add an "Error handling" JavaDocs section to fromCallable & co #6179

Closed
akarnokd opened this issue Aug 27, 2018 · 0 comments
Closed

Add an "Error handling" JavaDocs section to fromCallable & co #6179

akarnokd opened this issue Aug 27, 2018 · 0 comments
Labels
2.x Documentation good first issue PR welcome
Milestone
2.2 backlog

Comments

@akarnokd
Copy link
Member

The operators of fromCallable, fromAction and fromRunnable in the reactive classes could use an <dt><b>Error handling:</b></dt> section in the JavaDocs describing the regular and canceled/disposed behavior.

If the {@link Callable/Action/Runnable} throws an exception/exception/unchecked exception, the respective {@link Throwable} is delivered to the downstream via {@link Subscriber/Observer/.../#onError()}, except when the downstream has canceled/disposed this {@code Flowable/Observable/Single/Maybe/Completable} source. In this latter case, the Throwable is delivered to the global error handler via {@link RxJavaPlugins#onError(Throwable)} as {@link io.reactivex.exceptions.UndeliverableException UndeliverableException}.
@akarnokd akarnokd added this to the 2.2 backlog milestone Aug 27, 2018
@akarnokd akarnokd mentioned this issue Aug 28, 2018
Closed
luis-cortes pushed a commit to luis-cortes/RxJava that referenced this issue Sep 1, 2018
ReactiveX#6179 Adding Error handling javadocs to Observable.fromCalla…
85d051f 
…ble()
luis-cortes pushed a commit to luis-cortes/RxJava that referenced this issue Sep 2, 2018
ReactiveX#6179 Adding Error handling javadocs to Observable#fromCalla…
a873220 
…ble(), Single#fromCallable(), and Completable#fromCallable().
luis-cortes pushed a commit to luis-cortes/RxJava that referenced this issue Sep 2, 2018
ReactiveX#6179 Adding Error handling javadocs to Observable#fromCalla…
cef0ac5 
…ble(), Single#fromCallable(), and Completable#fromCallable().
luis-cortes pushed a commit to luis-cortes/RxJava that referenced this issue Sep 2, 2018
ReactiveX#6179 Adding Error handling javadocs to Observable#fromCalla…
ea52ed8 
…ble(), Single#fromCallable(), and Completable#fromCallable().
luis-cortes pushed a commit to luis-cortes/RxJava that referenced this issue Sep 2, 2018
ReactiveX#6179 Adding Error handling javadocs to Maybe#fromAction() a…
ee99e0b 
…nd Completable#fromAction().
@luis-cortes luis-cortes mentioned this issue Sep 2, 2018
Merged
luis-cortes pushed a commit to luis-cortes/RxJava that referenced this issue Sep 2, 2018
ReactiveX#6179 Removing cancellation language since only the `Flowabl…
58f3909 
…e` type has `cancel()`
luis-cortes pushed a commit to luis-cortes/RxJava that referenced this issue Sep 2, 2018
ReactiveX#6179 Adding error handling JavaDocs to Flowable#fromCallable()
5c1eeb9
akarnokd pushed a commit that referenced this issue Sep 3, 2018
@luis-cortes @akarnokd
Add "error handling" java docs section to from callable & co (#6193)
e0532b7 
* #6179 Adding Error handling javadocs to Observable#fromCallable(), Single#fromCallable(), and Completable#fromCallable().

* #6179 Adding Error handling javadocs to Maybe#fromAction() and Completable#fromAction().

* #6179 Removing cancellation language since only the `Flowable` type has `cancel()`

* #6179 Adding error handling JavaDocs to Flowable#fromCallable()
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
2.x Documentation good first issue PR welcome
Projects
None yet
Milestone
2.2 backlog
Development

No branches or pull requests
1 participant
@akarnokd