-
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
2.x: Improved XSubject JavaDocs #5802
Conversation
Codecov Report
@@ Coverage Diff @@
## 2.x #5802 +/- ##
============================================
- Coverage 96.23% 96.18% -0.06%
+ Complexity 5814 5807 -7
============================================
Files 634 634
Lines 41647 41647
Branches 5776 5776
============================================
- Hits 40081 40057 -24
- Misses 620 634 +14
- Partials 946 956 +10
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.
👍
* given {@code Disposable} being disposed immediately. | ||
* <p> | ||
* Calling {@link #onNext(Object)}, {@link #onError(Throwable)} and {@link #onComplete()} | ||
* is still required to be serialized (called from the same thread or called non-overlappingly from different threads |
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.
nit: After reading this multiple times I kinda want to remove "still" from the sentence
* Example usage: | ||
* <pre> {@code | ||
|
||
ReplaySubject<Object> subject = new ReplaySubject<>(); |
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.
Nice catch
This PR adds more detailed JavaDoc descriptions to the various
XSubject
types.Some of them are missing a marble diagram which will be created (or found) in a separate PR after this PR.
The
package-info.java
has been extended as well.