-
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: Expand {X}Processor JavaDocs by syncing with {X}Subject docs #6054
Conversation
* or the Subscribers receive the terminal event (error or completion) if this | ||
* Processor has terminated. | ||
* <p> | ||
* <img width="640" height="370" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/UnicastProcessor.png" alt=""> |
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.
Moved to the top after the first sentence.
Codecov Report
@@ Coverage Diff @@
## 2.x #6054 +/- ##
============================================
- Coverage 98.29% 98.28% -0.01%
+ Complexity 6193 6190 -3
============================================
Files 666 666
Lines 44802 44802
Branches 6206 6206
============================================
- Hits 44039 44035 -4
- Misses 229 232 +3
- Partials 534 535 +1
Continue to review full report at Codecov.
|
This PR expands and adapts the JavaDocs of
AsyncProcessor
,BehaviorProcessor
,PublishProcessor
,ReplayProcessor
andUnicastProcessor
with the details of their already documentedSubject
variants.In addition, some wording has been fixed with
UnicastSubject
as it was refering to pluralObserver
s in some sentences even though it only supports one.Since the basis of this expansion is copy-paste, please read through the changes carefully to verify the terminology and described behavior matches what's usually expected from
Flowable
s/FlowableProcessor
s (i.e., subjects don't have to deal with backpressure and thus nothing much to elaborate on that in a subject doc).