diff --git a/src/main/java/rx/Observable.java b/src/main/java/rx/Observable.java index 0b50ef9268..a1f14d789b 100644 --- a/src/main/java/rx/Observable.java +++ b/src/main/java/rx/Observable.java @@ -4444,20 +4444,26 @@ public final void onNext(T args) { return lift(new OperatorDoOnEach(observer)); } - + /** - * Modifies the source {@code Observable} so that it invokes the given action when it receives a request for - * more items. + * Modifies the source {@code Observable} so that it invokes the given action when it receives a + * request for more items. + *

+ * Note: This operator is for tracing the internal behavior of back-pressure request + * patterns and generally intended for debugging use. *

- *
Scheduler:
- *
{@code doOnRequest} does not operate by default on a particular {@link Scheduler}.
+ *
Scheduler:
+ *
{@code doOnRequest} does not operate by default on a particular {@link Scheduler}.
*
* * @param onRequest - * the action that gets called when an observer requests items from this {@code Observable} + * the action that gets called when an observer requests items from this + * {@code Observable} * @return the source {@code Observable} modified so as to call this Action when appropriate - * @see ReactiveX operators documentation: Do - * @since (if this graduates from Experimental/Beta to supported, replace this parenthetical with the release number) + * @see ReactiveX operators + * documentation: Do + * @since (if this graduates from Experimental/Beta to supported, replace this parenthetical + * with the release number) */ @Beta public final Observable doOnRequest(final Action1 onRequest) {