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: Prettify Flowable javadoc + validator #6806

Merged
merged 1 commit into from
Dec 31, 2019

Conversation

akarnokd
Copy link
Member

This PR unifies the Javadoc style of the Flowable type:

  • Mention of Flowable has to be {@code Flowable}
  • First mention of a set of types has to be {@link TheType}
  • Subsequent mention of a set of types has to be {@code TheType}
  • Some keywords and method names have to be {@code methodName}

In addition, JavadocWording has been modified to detect an additional set of wrong typename use.

@akarnokd akarnokd added this to the 3.0 milestone Dec 29, 2019
@akarnokd
Copy link
Member Author

Diff view due to a lot of changes: https://patch-diff.githubusercontent.com/raw/ReactiveX/RxJava/pull/6806.diff

@codecov
Copy link

codecov bot commented Dec 29, 2019

Codecov Report

Merging #6806 into 3.x will increase coverage by 0.02%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff              @@
##                3.x    #6806      +/-   ##
============================================
+ Coverage     98.22%   98.25%   +0.02%     
- Complexity     6387     6388       +1     
============================================
  Files           715      715              
  Lines         46496    46496              
  Branches       6371     6371              
============================================
+ Hits          45673    45684      +11     
+ Misses          298      291       -7     
+ Partials        525      521       -4
Impacted Files Coverage Δ Complexity Δ
.../main/java/io/reactivex/rxjava3/core/Flowable.java 100% <ø> (ø) 577 <0> (ø) ⬇️
.../operators/flowable/FlowableBlockingSubscribe.java 93.02% <0%> (-4.66%) 10% <0%> (-1%)
...java3/internal/observers/FutureSingleObserver.java 94.33% <0%> (-3.78%) 24% <0%> (-1%)
...eactivex/rxjava3/processors/BehaviorProcessor.java 96.55% <0%> (-2.47%) 50% <0%> (ø)
...ernal/operators/flowable/FlowableFromIterable.java 94.11% <0%> (-2.14%) 5% <0%> (ø)
...rnal/operators/observable/ObservableSwitchMap.java 91.57% <0%> (-2.11%) 3% <0%> (ø)
...tivex/rxjava3/internal/jdk8/ParallelCollector.java 91.74% <0%> (-1.84%) 2% <0%> (ø)
...ternal/operators/completable/CompletableMerge.java 97.29% <0%> (-1.36%) 2% <0%> (ø)
...nternal/operators/observable/ObservableCreate.java 97.43% <0%> (-0.86%) 2% <0%> (ø)
...ava3/internal/operators/parallel/ParallelJoin.java 92.04% <0%> (-0.76%) 3% <0%> (ø)
... and 18 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 34f381c...623e37d. Read the comment docs.

@akarnokd akarnokd merged commit 641e801 into ReactiveX:3.x Dec 31, 2019
@akarnokd akarnokd deleted the JavadocPretty_1228 branch December 31, 2019 09:39
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