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: Add a sentence to documentation of take() operator. #5718

Merged
merged 2 commits into from
Nov 11, 2017
Merged

2.x: Add a sentence to documentation of take() operator. #5718

merged 2 commits into from
Nov 11, 2017

Conversation

sadegh
Copy link
Contributor

@sadegh sadegh commented Nov 11, 2017

@codecov
Copy link

codecov bot commented Nov 11, 2017

Codecov Report

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

Impacted file tree graph

@@             Coverage Diff              @@
##                2.x    #5718      +/-   ##
============================================
+ Coverage     96.23%   96.27%   +0.03%     
+ Complexity     5822     5821       -1     
============================================
  Files           634      634              
  Lines         41604    41604              
  Branches       5761     5761              
============================================
+ Hits          40039    40054      +15     
- Misses          624      625       +1     
+ Partials        941      925      -16
Impacted Files Coverage Δ Complexity Δ
src/main/java/io/reactivex/Flowable.java 100% <ø> (ø) 525 <0> (ø) ⬇️
src/main/java/io/reactivex/Observable.java 100% <ø> (ø) 508 <0> (ø) ⬇️
...ex/internal/operators/flowable/FlowableCreate.java 90% <0%> (-7.42%) 6% <0%> (ø)
.../io/reactivex/internal/schedulers/IoScheduler.java 92.47% <0%> (-2.16%) 9% <0%> (ø)
...rnal/operators/flowable/FlowableFlatMapSingle.java 95.65% <0%> (-1.64%) 2% <0%> (ø)
...rnal/subscriptions/DeferredScalarSubscription.java 98.46% <0%> (-1.54%) 28% <0%> (-1%)
...a/io/reactivex/internal/util/QueueDrainHelper.java 60.28% <0%> (-1.42%) 32% <0%> (-1%)
...ain/java/io/reactivex/subjects/UnicastSubject.java 97.51% <0%> (-1.25%) 64% <0%> (-1%)
...ava/io/reactivex/processors/BehaviorProcessor.java 90.26% <0%> (-0.89%) 61% <0%> (-1%)
...nternal/operators/observable/ObservableCreate.java 97.43% <0%> (-0.86%) 2% <0%> (ø)
... and 29 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 da38036...7299fe3. Read the comment docs.

@@ -13391,6 +13391,8 @@ public final void subscribe(FlowableSubscriber<? super T> s) {
/**
* Returns a Flowable that emits those items emitted by source Publisher before a specified time runs
* out.
* If time runs out before Flowable is finished, termination events would be balled on provided {@link Scheduler},
Copy link
Member

Choose a reason for hiding this comment

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

A <p> would cleanly separate the first sentence and the rest of the Javadoc. Also the wording could use some refinement:

<p>
If time runs out before the {@code Flowable} completes normally, the {@code onComplete} 
event will be signaled on the default {@code computation} {@link Scheduler}.

@@ -13418,6 +13420,8 @@ public final void subscribe(FlowableSubscriber<? super T> s) {
/**
* Returns a Flowable that emits those items emitted by source Publisher before a specified time (on a
* specified Scheduler) runs out.
* If time runs out before Flowable is finished, termination events would be balled on provided {@link Scheduler},
Copy link
Member

Choose a reason for hiding this comment

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

<p>
If time runs out before the {@code Flowable} completes normally, the {@code onComplete} 
event will be signaled on the provided {@link Scheduler}.

@@ -11285,6 +11285,8 @@ public final void subscribe(Observer<? super T> observer) {
/**
* Returns an Observable that emits those items emitted by source ObservableSource before a specified time runs
* out.
* If time runs out before Observable is finished, termination events would be called on provided {@link Scheduler},
Copy link
Member

Choose a reason for hiding this comment

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

<p>
If time runs out before the {@code Observable} completes normally, the {@code onComplete} 
event will be signaled on the default {@code computation} {@link Scheduler}.

@@ -11308,6 +11310,8 @@ public final void subscribe(Observer<? super T> observer) {
/**
* Returns an Observable that emits those items emitted by source ObservableSource before a specified time (on a
* specified Scheduler) runs out.
* If time runs out before Observable is finished, termination events would be called on provided {@link Scheduler},
Copy link
Member

Choose a reason for hiding this comment

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

<p>
If time runs out before the {@code Flowable} completes normally, the {@code onComplete} 
event will be signaled on the provided {@link Scheduler}.

@akarnokd akarnokd changed the title Add a sentence to documentation of take() operator. 2.x: Add a sentence to documentation of take() operator. Nov 11, 2017
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.

Agreeing with david

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