Fix comment for GetKeyResult
#151
Merged
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.
The prior comment was unclear that the result of calling
value()was the key that was found by theKeySelector. I didn't realize what that method did until reading the code. I was assuming that the output ofvalue()would be the value associated with the located key.Personally, I would be tempted to change the name of the method to
key()to avoid confusion with the value associated with the key. Regardless of making that backwards incompatible change, this comment should make it easier to use.