Adds some documentation around connectable observable.

JakeWharton · Sep 9, 2015 · e3eb70a · e3eb70a
1 parent 282b869
commit e3eb70a
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/rxbinding/src/main/java/com/jakewharton/rxbinding/view/RxGestures.java b/rxbinding/src/main/java/com/jakewharton/rxbinding/view/RxGestures.java
@@ -10,10 +10,13 @@
 
 /**
  * Attaches a GestureDetector to the supplied touch event observable to be notified of
- * gesture events.
+ * gesture events. The RxGestures instance will subscribe to the supplied Observable, so
+ * if you'd like to have more than one subscriber you need to wrap it in a
+ * {@code ConnectableObservable} before passing it into this class.
  * <p>
  * {@code
- *  Observable<MotionEvent> touches = RxView.touches(view);
+ *  ConnectableObservable<ViewTouchEvent> touches = RxView.touches(view).publish();
+ *  touches.connect();
  *  RxGestures gestures = RxGestures.withTouches(view, touches);
  *  Observable<ViewGestureScrollEvent> scrolls = gestures.scroll();
  * }