Skip to content

3.x: Improve Javadocs of Completable and some others #6809

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

Merged
merged 1 commit into from
Jan 1, 2020

Conversation

akarnokd
Copy link
Member

@akarnokd akarnokd commented Dec 31, 2019

Improve the JavaDocs of Completable by

  • Using {@link} and {@code} tags
  • Adding @throws regarding parameter validation
  • Fix wording of some operators

@codecov
Copy link

codecov bot commented Dec 31, 2019

Codecov Report

Merging #6809 into 3.x will decrease coverage by 0.02%.
The diff coverage is 100%.

Impacted file tree graph

@@             Coverage Diff              @@
##                3.x    #6809      +/-   ##
============================================
- Coverage     98.28%   98.26%   -0.03%     
+ Complexity     6388     6387       -1     
============================================
  Files           715      715              
  Lines         46496    46498       +2     
  Branches       6371     6371              
============================================
- Hits          45698    45689       -9     
- Misses          281      288       +7     
- Partials        517      521       +4
Impacted Files Coverage Δ Complexity Δ
...vex/rxjava3/observables/ConnectableObservable.java 100% <ø> (ø) 12 <0> (ø) ⬇️
...in/java/io/reactivex/rxjava3/core/Completable.java 100% <ø> (ø) 120 <0> (ø) ⬇️
...activex/rxjava3/flowables/ConnectableFlowable.java 100% <ø> (ø) 12 <0> (ø) ⬇️
...eactivex/rxjava3/processors/BehaviorProcessor.java 96.55% <ø> (-2.47%) 50 <0> (ø)
...a/io/reactivex/rxjava3/disposables/Disposable.java 100% <100%> (ø) 9 <2> (ø) ⬇️
...activex/rxjava3/processors/MulticastProcessor.java 98.25% <100%> (-0.44%) 83 <2> (-1)
...ain/java/io/reactivex/rxjava3/core/Observable.java 100% <100%> (ø) 553 <1> (ø) ⬇️
...l/operators/observable/ObservableFlatMapMaybe.java 86.61% <0%> (-7.05%) 2% <0%> (ø)
.../operators/observable/ObservableFlatMapSingle.java 89.68% <0%> (-4.77%) 2% <0%> (ø)
.../operators/flowable/FlowableBlockingSubscribe.java 93.02% <0%> (-4.66%) 10% <0%> (-1%)
... and 26 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 641e801...df962b3. Read the comment docs.

@akarnokd akarnokd merged commit ecfb6b7 into ReactiveX:3.x Jan 1, 2020
@akarnokd akarnokd deleted the JavadocPrettify_1231 branch January 1, 2020 13:33
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.

1 participant