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

3.x: Improve JavaDocs of Observable and fix similar issues elsewhere #6831

Merged
merged 3 commits into from
Jan 10, 2020

Conversation

akarnokd
Copy link
Member

@akarnokd akarnokd commented Jan 9, 2020

Improve the Javadoc of Observable:

  • Use {@code and {@link} tags uniformly.
  • Improve wording of many operators.
  • Add @throws declaration for validation exceptions.
  • Add missing or incorrect requireNonNull usages.
  • Have skipLast and takeLast throw IllegalArgumentException instead of IndexOutOfBoundsException.
  • Improve the various validator tests to detect more cases.
  • Change argument names from prefetch to the more appropriate bufferSize.

@codecov
Copy link

codecov bot commented Jan 9, 2020

Codecov Report

❗ No coverage uploaded for pull request base (3.x@6030d83). Click here to learn what that means.
The diff coverage is 100%.

Impacted file tree graph

@@          Coverage Diff           @@
##             3.x    #6831   +/-   ##
======================================
  Coverage       ?   98.23%           
  Complexity     ?     6380           
======================================
  Files          ?      715           
  Lines          ?    46502           
  Branches       ?     6384           
======================================
  Hits           ?    45681           
  Misses         ?      295           
  Partials       ?      526
Impacted Files Coverage Δ Complexity Δ
...rators/observable/ObservableBlockingSubscribe.java 97.14% <ø> (ø) 9 <0> (?)
...ain/java/io/reactivex/rxjava3/core/Observable.java 100% <ø> (ø) 551 <0> (?)
.../operators/flowable/FlowableBlockingSubscribe.java 97.67% <100%> (ø) 11 <0> (?)
src/main/java/io/reactivex/rxjava3/core/Maybe.java 100% <100%> (ø) 179 <8> (?)
...rc/main/java/io/reactivex/rxjava3/core/Single.java 100% <100%> (ø) 151 <3> (?)
.../main/java/io/reactivex/rxjava3/core/Flowable.java 100% <100%> (ø) 575 <17> (?)
...in/java/io/reactivex/rxjava3/core/Completable.java 100% <100%> (ø) 120 <1> (?)
...o/reactivex/rxjava3/parallel/ParallelFlowable.java 100% <100%> (ø) 57 <18> (?)

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 6030d83...408a507. Read the comment docs.

@akarnokd akarnokd merged commit 1e4dbcf into ReactiveX:3.x Jan 10, 2020
@akarnokd akarnokd deleted the JavaDocCleanupObservable3x_0108 branch January 10, 2020 07:36
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.

None yet

1 participant