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.

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

Merged
merged 3 commits into from
Jun 21, 2018

Conversation

akarnokd
Copy link
Member

This PR expands and adapts the JavaDocs of AsyncProcessor, BehaviorProcessor, PublishProcessor, ReplayProcessor and UnicastProcessor with the details of their already documented Subject variants.

In addition, some wording has been fixed with UnicastSubject as it was refering to plural Observers 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 Flowables/FlowableProcessors (i.e., subjects don't have to deal with backpressure and thus nothing much to elaborate on that in a subject doc).

@akarnokd akarnokd added this to the 2.2 milestone Jun 21, 2018
* 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="">
Copy link
Member Author

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
Copy link

codecov bot commented Jun 21, 2018

Codecov Report

Merging #6054 into 2.x will decrease coverage by <.01%.
The diff coverage is n/a.

Impacted file tree graph

@@             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
Impacted Files Coverage Δ Complexity Δ
src/main/java/io/reactivex/Maybe.java 100% <ø> (ø) 171 <0> (ø) ⬇️
.../java/io/reactivex/processors/ReplayProcessor.java 99.58% <ø> (ø) 52 <0> (ø) ⬇️
...n/java/io/reactivex/processors/AsyncProcessor.java 99.08% <ø> (ø) 52 <0> (ø) ⬇️
...java/io/reactivex/processors/PublishProcessor.java 100% <ø> (ø) 43 <0> (ø) ⬇️
...ava/io/reactivex/processors/BehaviorProcessor.java 99.1% <ø> (ø) 60 <0> (ø) ⬇️
src/main/java/io/reactivex/Observable.java 100% <ø> (ø) 539 <0> (ø) ⬇️
...ain/java/io/reactivex/subjects/UnicastSubject.java 100% <ø> (ø) 65 <0> (ø) ⬇️
...java/io/reactivex/processors/UnicastProcessor.java 98.8% <ø> (-1.2%) 67 <0> (-1)
...l/operators/observable/ObservableFlatMapMaybe.java 91.5% <0%> (-5.23%) 2% <0%> (ø)
...a/io/reactivex/internal/util/QueueDrainHelper.java 95.83% <0%> (-4.17%) 55% <0%> (-3%)
... and 22 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6dd1648...ca4d323. Read the comment docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants