Update IteratorTester example with a greater "steps" value #5281
Conversation
This file contains 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
This allows IteratorTester to check the edge case that when an iterator has been exhausted (that is, "next" has been called repeatedly until "hasNext" returns false) then calling "next" on the iterator again exhibits the same behavior as the user's chosen "known good" reference implementation.
cpovirk
reviewed
Oct 15, 2020
| @@ -50,6 +50,10 @@ | |||
| * verify() method, which is called <em>after</em> each sequence and is guaranteed to be called | |||
| * using the latest values obtained from {@link IteratorTester#newTargetIterator()}. | |||
| * | |||
| * <p>The value you pass to the parameter {@code steps} should be greater than the length of your | |||
| * iterator, so that this class can check that your iterator exhibits the same edge-case behavior as | |||
There was a problem hiding this comment.
What do you think of just saying "...that your iterator exhibits the correct behavior when it is exhaused?"
There was a problem hiding this comment.
Yep, that sounds good to me. 👍
There was a problem hiding this comment.
I'm not sure if you were expecting me to update the docs or if you were happy to do it yourself?
There was a problem hiding this comment.
Sorry, I'm taking care of it. The PR is out for internal review.
There was a problem hiding this comment.
Cheers @cpovirk! 👍
Merged
cpovirk
pushed a commit
that referenced
this pull request
Oct 16, 2020
This allows IteratorTester to check the edge case that when an iterator has been exhausted (that is, "next" has been called repeatedly until "hasNext" returns false) then calling "next" on the iterator again exhibits the same behavior as the user's chosen "known good" reference implementation. Fixes #5281 RELNOTES=n/a ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=337541752
cpovirk
pushed a commit
that referenced
this pull request
Oct 16, 2020
This allows IteratorTester to check the edge case that when an iterator has been exhausted (that is, "next" has been called repeatedly until "hasNext" returns false) then calling "next" on the iterator again exhibits the same behavior as the user's chosen "known good" reference implementation. Fixes #5281 RELNOTES=n/a ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=337541752
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.
Builds upon my earlier work in #5272 and #5276, whilst also addressing #5254 a bit.