Provide a better example for get!(f::Function, collection, key)
#36964
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
I've needed `get!(f::Function, collection, key)` in the past, but the example given in the docstring was confusing or even actively misleading. So I didn't realize that `get!(f::Function, collection, key)` was in fact the right function. Instead, I ended up writing the naive code like this:
```julia
if haskey(d, k)
return d[k]
else
return d[k] = foo(a)
end
```
So, I've changed the example for `get!(f::Function, collection, key)`. I think the new example better motivates the usage of `get!`.
The example for `get(f::Function, collection, key)` (the non-mutating version) should probably also be updated. However, I'm actually not sure of a good example for the case where you don't update the dictionary.
simeonschaub
pushed a commit
to simeonschaub/julia
that referenced
this pull request
Aug 11, 2020
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've needed
get!(f::Function, collection, key)in the past, but the example given in the docstring was confusing or even actively misleading. So I didn't realize thatget!(f::Function, collection, key)was in fact the right function. Instead, I ended up writing the naive code like this:So, I've changed the example for
get!(f::Function, collection, key). I think the new example better motivates the usage ofget!.The example for
get(f::Function, collection, key)(the non-mutating version) should probably also be updated. However, I'm actually not sure of a good example for the case where you don't update the dictionary.