fix type definitions - #42
Open
ethanresnick wants to merge 1 commit into
Open
Conversation
`entries()` was typed as returning an iterator, but it actually returns an iterable. (If it returned an iterator, you could call `map.entries().next()`, but that's a runtime error.) Meanwhile, `keys()` and `values()` do return iterators, which makes their types correct but their behavior a bit inconsistent with `entries()`. I'm not sure if that inconsistency is an issue, but addressing it would require a breaking change, so I stuck to just fixing the types in this PR.
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
1 participant
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.
entries()was typed as returning an iterator, but it actually returns an iterable. (If it returned an iterator, you could callmap.entries().next(), but that's a runtime error.)Meanwhile,
keys()andvalues()do return iterators, which makes their types correct but their behavior a bit inconsistent withentries(). I'm not sure if that inconsistency is an issue, so I stuck to just fixing the types in this PR.If the goal is to match the behavior of the built-in
Mapclass, probablyentries()really should return an iterator. To do that (in a sane way), though, woul be a breaking change.