Add doctest for IdDict with example #38881
Merged
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 came up from a Slack discussion and was based on a surprising [Python behavior](https://twitter.com/DahlitzF/status/1338384990040682498). @haampie provided the example and I thought the docstrings could help out another beginner to understand why a different data structure is justified.
base/iddict.jl
Outdated
| @@ -6,7 +6,23 @@ | |||
| `IdDict{K,V}()` constructs a hash table using object-id as hash and | |||
| `===` as equality with keys of type `K` and values of type `V`. | |||
|
|
|||
| See [`Dict`](@ref) for further help. | |||
| See [`Dict`](@ref) for further help. In the example below, The `Dict` | |||
| keys all hash to the same value as they are inserted and type-promoted, | |||
There was a problem hiding this comment.
There isn't really any type promotion going on here though, the values are all isequal and hash the same.
There was a problem hiding this comment.
Thanks for the catch. Should be fixed.
ElOceanografo
pushed a commit
to ElOceanografo/julia
that referenced
this pull request
May 4, 2021
This came up from a Slack discussion and was based on a surprising [Python behavior](https://twitter.com/DahlitzF/status/1338384990040682498). @haampie provided the example and I thought the docstrings could help out another beginner to understand why a different data structure is justified.
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.
This came up from a Slack discussion and was based on a surprising Python behavior.
@haampie provided the example and I thought the docstrings could help out another beginner to understand why a different data structure is justified.