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: Javadoc space cleanup #6005

Merged
merged 3 commits into from
May 9, 2018
Merged

2.x: Javadoc space cleanup #6005

merged 3 commits into from
May 9, 2018

Conversation

akarnokd
Copy link
Member

@akarnokd akarnokd commented May 9, 2018

This PR adds a gradle task to replace the excessive whitespaces generated into the Javadocs between method arguments and after method argument annotations.

This task should run before the javadoc gets packaged up for maven and before it gets pushed back to the gh-pages.

(This was created as a repo branch so that the snapshot pushback is triggered, see the comparison links below.)

Resolves: #6004

Comparison

Multiple parameters before: combineLatest

image

Multiple parameters after: combineLatest snapshot

image


Newline after parameter annotation before: as

image

Newline after parameter annotation after: as snapshot

image

@codecov
Copy link

codecov bot commented May 9, 2018

Codecov Report

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

Impacted file tree graph

@@             Coverage Diff              @@
##                2.x    #6005      +/-   ##
============================================
+ Coverage     98.19%   98.35%   +0.16%     
- Complexity     6061     6065       +4     
============================================
  Files           656      656              
  Lines         44101    44101              
  Branches       6118     6118              
============================================
+ Hits          43304    43376      +72     
+ Misses          245      213      -32     
+ Partials        552      512      -40
Impacted Files Coverage Δ Complexity Δ
...rnal/subscriptions/DeferredScalarSubscription.java 98.46% <0%> (-1.54%) 28% <0%> (-1%)
...internal/operators/flowable/FlowableSwitchMap.java 95.28% <0%> (-1.42%) 3% <0%> (ø)
...rnal/operators/flowable/FlowableFlatMapSingle.java 94.56% <0%> (-1.09%) 2% <0%> (ø)
...ernal/operators/flowable/FlowableTimeoutTimed.java 98.37% <0%> (-0.82%) 3% <0%> (ø)
...ernal/operators/flowable/FlowableFromIterable.java 97.32% <0%> (ø) 5% <0%> (ø) ⬇️
...ternal/operators/flowable/FlowableWindowTimed.java 91.62% <0%> (+0.22%) 4% <0%> (ø) ⬇️
...ternal/operators/observable/ObservableFlatMap.java 87.22% <0%> (+0.31%) 3% <0%> (ø) ⬇️
...main/java/io/reactivex/subjects/ReplaySubject.java 98.11% <0%> (+0.41%) 50% <0%> (ø) ⬇️
...x/internal/operators/flowable/FlowableFlatMap.java 90% <0%> (+0.52%) 4% <0%> (ø) ⬇️
...nternal/operators/parallel/ParallelSortedJoin.java 95.62% <0%> (+0.72%) 2% <0%> (ø) ⬇️
... and 20 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 fefcfed...fce6aff. Read the comment docs.

Copy link
Collaborator

@vanniktech vanniktech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Subjects and Processors are rendering fine?

@akarnokd
Copy link
Member Author

akarnokd commented May 9, 2018

Well, ReplaySubject's multi-parameter methods are a bit misaligned too. Will update list of files.

@akarnokd
Copy link
Member Author

akarnokd commented May 9, 2018

There seems to be a Travis-CI problem; the build is just stuck at the pre-init phase after the network check.

@akarnokd akarnokd merged commit 8a28169 into 2.x May 9, 2018
@akarnokd akarnokd deleted the JavadocSpaceCleanup branch May 9, 2018 17:13
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