2.x: javadoc: fix wording of some operators, remove @throws implications#4839
Merged
akarnokd merged 2 commits intoReactiveX:2.xfrom Nov 11, 2016
Merged
2.x: javadoc: fix wording of some operators, remove @throws implications#4839akarnokd merged 2 commits intoReactiveX:2.xfrom
akarnokd merged 2 commits intoReactiveX:2.xfrom
Conversation
Current coverage is 95.70% (diff: 100%)@@ 2.x #4839 diff @@
==========================================
Files 580 580
Lines 37174 37174
Methods 0 0
Messages 0 0
Branches 5600 5600
==========================================
- Hits 35610 35577 -33
- Misses 644 660 +16
- Partials 920 937 +17
|
JakeWharton
approved these changes
Nov 11, 2016
|
|
||
| /** | ||
| * Returns a Flowable that emits the item found at a specified index in a sequence of emissions from a | ||
| * Returns a Flowable that emits the item found at a specified index in a sequence of emissions from |
Contributor
There was a problem hiding this comment.
Actually or use "this Flowable" like the others
| * within time windows defined by the timeout selectors | ||
| * @throws NullPointerException | ||
| * if {@code itemTimeoutIndicator} is null | ||
| * if {@code other} is null |
Contributor
There was a problem hiding this comment.
You might want to look at the rendered Javadoc here. I'm betting these get smashed together with only a single space. Might be better to switch to {@code itemTimeoutIndicator} or {@code other} is null.
Member
Author
|
Thanks @JakeWharton, fixed those problems. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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 fixes some javadoc mistakes with operators such as
single,first,lastand co and removes@throwstags from operators since those don't throw it when the method is invoked.