Make spec clearer for update functions in Map #10223
Merged
Conversation
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
eksperimental
force-pushed
the
map_get_and_update_specs
branch
from
d5417f3 to
e571ddb
Compare
* It removes the concept of the "get" value (which should have been "gotten" IMO). * Renames "initial" argument to "default" * Makes use of the concept of "current value" which was already present in some functions, and uses this in the examples and the specs consistently
josevalim
reviewed
Jul 22, 2020
josevalim
reviewed
Jul 22, 2020
| %{a: 2} | ||
| iex> Map.update(%{a: 1}, :b, 11, &(&1 * 2)) |
There was a problem hiding this comment.
I definitely prefer existing_value, as it makes it clear it won't be called if there is no value.
There was a problem hiding this comment.
True! they are really good names for stressing the distinction
josevalim
reviewed
Jul 22, 2020
| @@ -845,7 +845,9 @@ defmodule Map do | |||
| {nil, %{a: 1}} | |||
|
|
|||
| """ | |||
| @spec get_and_update(map, key, (value -> {get, value} | :pop)) :: {get, map} when get: term | |||
| @spec get_and_update(map, key, (value -> {current_value, new_value :: value} | :pop)) :: | |||
| {current_value, map} | |||
There was a problem hiding this comment.
👍 for current_value here, as it is also called if the value is nil. I also like new_value!
josevalim
reviewed
Jul 22, 2020
|
💚 💙 💜 💛 ❤️ |
eksperimental
added a commit
to eksperimental-forks/elixir
that referenced
this pull request
Jul 23, 2020
Inspired by c1a538e (elixir-lang#10223) * Fixes the spec of Keyword.get_and_update!/3 that was missing the :pop return value for the update function * It removes the concept of the "get" value and replaced it consistently with "current value" * Renames "initial" argument to "default" * Uses "existing value" when applicable
josevalim
pushed a commit
that referenced
this pull request
Jul 23, 2020
Inspired by c1a538e (#10223) * Fixes the spec of Keyword.get_and_update!/3 that was missing the :pop return value for the update function * It removes the concept of the "get" value and replaced it consistently with "current value" * Renames "initial" argument to "default" * Uses "existing value" when applicable
eksperimental
added a commit
to eksperimental-forks/elixir
that referenced
this pull request
Jul 27, 2020
To be consistent with recently introduced changes: elixir-lang#10228, elixir-lang#10223
josevalim
pushed a commit
that referenced
this pull request
Jul 27, 2020
eksperimental
added a commit
to eksperimental-forks/elixir
that referenced
this pull request
Mar 27, 2021
In the same fashion of PRs elixir-lang#10228 and elixir-lang#10223 Replaces: - `get_values` with `current_value` - `update_value` with `new_value` - `data` with `new_data` when suitable Adds nil as an argument term in the function spec.
josevalim
pushed a commit
that referenced
this pull request
Mar 27, 2021
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.
Uh oh!
There was an error while loading. Please reload this page.