2.x: Improve BehaviorSubject JavaDoc + related clarifications #5780
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
This was referenced Dec 27, 2017
Codecov Report
@@ Coverage Diff @@
## 2.x #5780 +/- ##
============================================
- Coverage 96.27% 96.21% -0.07%
- Complexity 5807 5809 +2
============================================
Files 634 634
Lines 41607 41607
Branches 5770 5770
============================================
- Hits 40057 40031 -26
- Misses 611 634 +23
- Partials 939 942 +3
Continue to review full report at Codecov.
|
vanniktech
approved these changes
Dec 27, 2017
tony-root
reviewed
Dec 28, 2017
| * @param error the error to report | ||
| * @see #getErrorHandler() | ||
| * @see #setErrorHandler(Consumer) |
There was a problem hiding this comment.
@akarnokd
Do you think it makes sense to reference
https://github.com/ReactiveX/RxJava/wiki/What's-different-in-2.0#error-handling
here?
Is it acceptable to reference Wiki from javadoc?
| @@ -337,7 +337,23 @@ public static Scheduler onComputationScheduler(@NonNull Scheduler defaultSchedul | |||
|
|
|||
| /** | |||
| * Called when an undeliverable error occurs. | |||
| * <p> | |||
| * Undeliverable errors are those {@code Observer.onError()} invocations that are not allowed happen to | |||
There was a problem hiding this comment.
Nit:
.. that are not allowed to happen to ...
?
tony-root
approved these changes
Dec 28, 2017
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.
This PR adds detailed behavior and feature description to the
BehaviorSubjectJavaDoc.In addition, small mistakes in the
BehaviorProcessorJavaDoc have also been fixed and both received an extra section:Error handlingthat points at the global error handler for undeliverable errors. Due to this link, theRxJavaPlugins.onErrorJavaDoc has been also expanded.