Fix a misleading documentation of Observable.singleElement() #5668
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
akarnokd
reviewed
Oct 15, 2017
| * 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 emits the single item emitted by this Observable or completes if this Observable is empty. |
There was a problem hiding this comment.
The problem with two sentences is that most IDEs and the Javadoc method listing shows only the first sentence. Could you rewrite it that all relevant behavior is in the same sentence?
Codecov Report
@@ Coverage Diff @@
## 2.x #5668 +/- ##
============================================
- Coverage 96.22% 96.21% -0.01%
- Complexity 5814 5816 +2
============================================
Files 633 633
Lines 41553 41553
Branches 5752 5752
============================================
- Hits 39984 39980 -4
+ Misses 628 626 -2
- Partials 941 947 +6
Continue to review full report at Codecov.
|
87 tasks
|
Here is the standard link for the marble:
|
|
Thanks, updated the JavaDoc to include the Marble diagram :) |
akarnokd
approved these changes
Oct 15, 2017
vanniktech
approved these changes
Oct 15, 2017
| @@ -282,6 +282,7 @@ public void testSingleWithEmpty() { | |||
|
|
|||
| InOrder inOrder = inOrder(observer); | |||
| inOrder.verify(observer).onComplete(); | |||
| inOrder.verify(observer, never()).onError(any(Throwable.class)); | |||
There was a problem hiding this comment.
This is actually covered by verifyNoMoreInteractions but being explicit here doesn't hurt.
mithunsasidharan
added a commit
to mithunsasidharan/RxJava
that referenced
this pull request
Oct 15, 2017
Fix a misleading documentation of Observable.singleElement() (ReactiveX#5668)
This was referenced Oct 18, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR improves the documentation of
Observable.singleElement(), as mentioned in #5317.An appropriate unit test to verify the
emptybehaviour already exist (ObservableSingleTest. testSingleWithEmpty()), I just added one more check there to make it very explicit that an error is not thrown.As a side note, I'm attaching an updated Marble diagram for the method that includes all 3 states of the resulting Maybe (empty, success, error). I believe this is listed in #5319.