Fix a misleading documentation of Observable.singleElement() (ReactiveX#5668)

VeskoI · akarnokd · commit cd6bc08c5bf1 · 2017-10-15T12:06:23.000+02:00
* Fix a misleading documentation of Observable.singleElement()

* Reduce the first part of Observable.singleElement() JavaDoc to a single sentence.

* Update the Marble diagram of Observable.singleElement()
diff --git a/src/main/java/io/reactivex/Observable.java b/src/main/java/io/reactivex/Observable.java
@@ -10277,11 +10277,10 @@ public final Observable<T> share() {
     }
 
     /**
-     * Returns a Maybe that emits the single item emitted by this Observable if this Observable
-     * emits only a single item, otherwise if this Observable emits more than one item or no items, an
-     * {@code IllegalArgumentException} or {@code NoSuchElementException} is signalled respectively.
+     * Returns a Maybe that completes if this Observable is empty or emits the single item emitted by this Observable,
+     * or signals an {@code IllegalArgumentException} if this Observable emits more than one item.
      * <p>
-     * <img width="640" height="315" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/singleElement.png" alt="">
+     * <img width="640" height="217" src="https://raw.githubusercontent.com/wiki/ReactiveX/RxJava/images/rx-operators/singleElement.o.png" alt="">
      * <dl>
      *  <dt><b>Scheduler:</b></dt>
      *  <dd>{@code singleElement} does not operate by default on a particular {@link Scheduler}.</dd>
diff --git a/src/test/java/io/reactivex/internal/operators/observable/ObservableSingleTest.java b/src/test/java/io/reactivex/internal/operators/observable/ObservableSingleTest.java
@@ -282,6 +282,7 @@ public void testSingleWithEmpty() {
 
         InOrder inOrder = inOrder(observer);
         inOrder.verify(observer).onComplete();
+        inOrder.verify(observer, never()).onError(any(Throwable.class));
         inOrder.verifyNoMoreInteractions();
     }
 

Original file line number	Diff line number	Diff line change
`@@ -282,6 +282,7 @@ public void testSingleWithEmpty() {`
`282`	`282`
`283`	`283`	`InOrder inOrder = inOrder(observer);`
`284`	`284`	`inOrder.verify(observer).onComplete();`
	`285`	`+ inOrder.verify(observer, never()).onError(any(Throwable.class));`
`285`	`286`	`inOrder.verifyNoMoreInteractions();`
`286`	`287`	`}`
`287`	`288`