Skip to content

Commit bab4e8b

Browse files
sadeghakarnokd
authored andcommitted
2.x: Add a sentence to documentation of take() operator. (#5718)
* Add a sentence to documentation of take() operator * Rephrase java doc for take() method
1 parent da38036 commit bab4e8b

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

src/main/java/io/reactivex/Flowable.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13392,6 +13392,9 @@ public final Flowable<T> take(long count) {
1339213392
* Returns a Flowable that emits those items emitted by source Publisher before a specified time runs
1339313393
* out.
1339413394
* <p>
13395+
* If time runs out before the {@code Flowable} completes normally, the {@code onComplete} event will be
13396+
* signaled on the default {@code computation} {@link Scheduler}.
13397+
* <p>
1339513398
* <img width="640" height="305" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/take.t.png" alt="">
1339613399
* <dl>
1339713400
* <dt><b>Backpressure:</b></dt>
@@ -13419,6 +13422,9 @@ public final Flowable<T> take(long time, TimeUnit unit) {
1341913422
* Returns a Flowable that emits those items emitted by source Publisher before a specified time (on a
1342013423
* specified Scheduler) runs out.
1342113424
* <p>
13425+
* If time runs out before the {@code Flowable} completes normally, the {@code onComplete} event will be
13426+
* signaled on the provided {@link Scheduler}.
13427+
* <p>
1342213428
* <img width="640" height="305" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/take.ts.png" alt="">
1342313429
* <dl>
1342413430
* <dt><b>Backpressure:</b></dt>

src/main/java/io/reactivex/Observable.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11286,6 +11286,9 @@ public final Observable<T> take(long count) {
1128611286
* Returns an Observable that emits those items emitted by source ObservableSource before a specified time runs
1128711287
* out.
1128811288
* <p>
11289+
* If time runs out before the {@code Observable} completes normally, the {@code onComplete} event will be
11290+
* signaled on the default {@code computation} {@link Scheduler}.
11291+
* <p>
1128911292
* <img width="640" height="305" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/take.t.png" alt="">
1129011293
* <dl>
1129111294
* <dt><b>Scheduler:</b></dt>
@@ -11309,6 +11312,9 @@ public final Observable<T> take(long time, TimeUnit unit) {
1130911312
* Returns an Observable that emits those items emitted by source ObservableSource before a specified time (on a
1131011313
* specified Scheduler) runs out.
1131111314
* <p>
11315+
* If time runs out before the {@code Observable} completes normally, the {@code onComplete} event will be
11316+
* signaled on the provided {@link Scheduler}.
11317+
* <p>
1131211318
* <img width="640" height="305" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/take.ts.png" alt="">
1131311319
* <dl>
1131411320
* <dt><b>Scheduler:</b></dt>

0 commit comments

Comments
 (0)