clarifying iterator trait documentation #15897
Closed
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
| @@ -100,6 +100,7 @@ pub trait Iterator<A> { | |||
| fn next(&mut self) -> Option<A>; | |||
|
|
|||
| /// Return a lower bound and upper bound on the remaining length of the iterator. | |||
| /// In the case that a valid upper bound cannot fit within a uint, None should be returned. | |||
There was a problem hiding this comment.
"None" should use backticks, e.g. None. Also, this documentation here is primarily aimed at the user instead of the implementor. This could be rephrased as
Returns a lower and upper bound on the remaining length of the iterator.
An upper bound ofNonemeans either there is no known upper bound, or the upper bound
does not fit within auint.
|
@kballard: How's it look now? |
| pub trait RandomAccessIterator<A>: Iterator<A> { | ||
| /// Return the number of indexable elements. At most `std::uint::MAX` | ||
| /// elements are indexable, even if the iterator represents a longer range. | ||
| fn indexable(&self) -> uint; | ||
|
|
||
| /// Return an element at an index | ||
| /// Return an element at an index, or None if the index is out of bounds |
There was a problem hiding this comment.
None needs backticks, as in None
There was a problem hiding this comment.
God damn, I double checked that I got them all and everything. I suck. Fixed.
|
LGTM. r=me if you squash all your commits together. |
|
@kballard commits squashed. |
bors
added a commit
that referenced
this pull request
Jul 23, 2014
I found these things to be ambiguous, or at least worth stating explicitly to reduce the amount a user/developer needs to think about the API.
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.
I found these things to be ambiguous, or at least worth stating explicitly to reduce the amount a user/developer needs to think about the API.