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

Update the Javadoc of the retry operator #6458

Merged

Conversation

RomanWuattier
Copy link
Contributor

Specify that the times function parameter describes "the number of times
to resubscribe if the current Observable fails".

Solves: #6402

@RomanWuattier
Copy link
Contributor Author

Bellow is the marble with the number of retries decreased from 2 to 1. If the marble is correct, can you upload it to the repository?
retry o n

@akarnokd
Copy link
Member

Sure. Could you also make sure all the other counted retry() operators in the other base classes have the correct wording?

@RomanWuattier RomanWuattier force-pushed the update-observable-retry-documentation branch from ce19a9b to fb98b60 Compare April 11, 2019 21:12
@codecov
Copy link

codecov bot commented Apr 11, 2019

Codecov Report

Merging #6458 into 2.x will decrease coverage by <.01%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff              @@
##                2.x    #6458      +/-   ##
============================================
- Coverage     98.26%   98.25%   -0.01%     
+ Complexity     6295     6293       -2     
============================================
  Files           675      675              
  Lines         45173    45173              
  Branches       6246     6246              
============================================
- Hits          44387    44386       -1     
- Misses          245      248       +3     
+ Partials        541      539       -2
Impacted Files Coverage Δ Complexity Δ
src/main/java/io/reactivex/Flowable.java 100% <ø> (ø) 567 <0> (ø) ⬇️
src/main/java/io/reactivex/Maybe.java 100% <ø> (ø) 173 <0> (ø) ⬇️
src/main/java/io/reactivex/Completable.java 100% <ø> (ø) 120 <0> (ø) ⬇️
src/main/java/io/reactivex/Observable.java 100% <ø> (ø) 542 <0> (ø) ⬇️
...nternal/operators/observable/ObservableCreate.java 96.58% <0%> (-2.57%) 2% <0%> (ø)
...perators/single/SingleFlatMapIterableFlowable.java 95.83% <0%> (-2.5%) 2% <0%> (ø)
...ernal/operators/flowable/FlowableFlatMapMaybe.java 93.71% <0%> (-1.94%) 2% <0%> (ø)
.../io/reactivex/disposables/CompositeDisposable.java 98.14% <0%> (-1.86%) 39% <0%> (-1%)
...java/io/reactivex/processors/UnicastProcessor.java 98.8% <0%> (-1.2%) 67% <0%> (-1%)
...io/reactivex/subscribers/SerializedSubscriber.java 98.86% <0%> (-1.14%) 26% <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 3958d1b...d7273d6. Read the comment docs.

@RomanWuattier RomanWuattier force-pushed the update-observable-retry-documentation branch from fb98b60 to fcb3f09 Compare April 11, 2019 21:15
@RomanWuattier
Copy link
Contributor Author

Sure.
I updated every base classes. Also, I grabbed this opportunity to update some unit tests to illustrate the Javadoc wording.

Please, note:

@RomanWuattier RomanWuattier changed the title Update the Javadoc of the Observable.retry operator Update the Javadoc of the retry operator Apr 11, 2019
Specify that the `times` function parameter describes "the number of times
to resubscribe if the current *operator* fails".

Also, this commit updates some unit tests to illustrate the Javadoc wording.

Solves: ReactiveX#6402
@RomanWuattier RomanWuattier force-pushed the update-observable-retry-documentation branch from fcb3f09 to d7273d6 Compare April 11, 2019 21:29
@akarnokd
Copy link
Member

Nice! Thanks!

@akarnokd akarnokd merged commit c04cfb8 into ReactiveX:2.x Apr 12, 2019
@RomanWuattier RomanWuattier deleted the update-observable-retry-documentation branch April 12, 2019 12: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.

3 participants