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: Improve BehaviorProcessor JavaDoc #5778

Merged
merged 2 commits into from
Dec 27, 2017

Conversation

akarnokd
Copy link
Member

A StackOverflow question prompted me to look at BehaviorProcessor to find it quite lacking of a detailed JavaDoc. This PR adds sentences and examples (I could think of) to it that explain the available features and behavior of this Processor implementation.

If the sentences are reviewed, the BehaviorSubject will be updated with the applicable information (i.e., everything minus backpressure related sentences).

@akarnokd akarnokd added this to the 2.2 milestone Dec 26, 2017
@codecov
Copy link

codecov bot commented Dec 26, 2017

Codecov Report

Merging #5778 into 2.x will increase coverage by 0.07%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff              @@
##                2.x    #5778      +/-   ##
============================================
+ Coverage     96.25%   96.33%   +0.07%     
  Complexity     5810     5810              
============================================
  Files           634      634              
  Lines         41607    41607              
  Branches       5770     5770              
============================================
+ Hits          40049    40082      +33     
+ Misses          629      600      -29     
+ Partials        929      925       -4
Impacted Files Coverage Δ Complexity Δ
...ava/io/reactivex/processors/BehaviorProcessor.java 95.06% <ø> (+4.03%) 59 <0> (-1) ⬇️
...l/operators/observable/ObservableFlatMapMaybe.java 89.54% <0%> (-7.19%) 2% <0%> (ø)
...a/io/reactivex/internal/queue/MpscLinkedQueue.java 98.03% <0%> (-1.97%) 17% <0%> (-1%)
...perators/single/SingleFlatMapIterableFlowable.java 96.66% <0%> (-1.67%) 2% <0%> (ø)
...vex/internal/subscribers/QueueDrainSubscriber.java 50% <0%> (-1.57%) 15% <0%> (-1%)
...x/internal/operators/flowable/FlowablePublish.java 94.71% <0%> (-1.33%) 11% <0%> (ø)
...ternal/operators/observable/ObservablePublish.java 92.1% <0%> (-0.88%) 10% <0%> (-1%)
...nternal/operators/parallel/ParallelSortedJoin.java 94.92% <0%> (-0.73%) 2% <0%> (ø)
...nternal/operators/observable/ObservableReplay.java 98.05% <0%> (-0.56%) 23% <0%> (ø)
...vex/internal/operators/parallel/ParallelRunOn.java 97.1% <0%> (-0.49%) 8% <0%> (ø)
... and 21 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 20a72ca...ed68f31. Read the comment docs.

@akarnokd akarnokd merged commit a1c3ba9 into ReactiveX:2.x Dec 27, 2017
@akarnokd akarnokd deleted the BehaviorProcessorJavaDoc branch December 27, 2017 11:01
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