Doubt about `update_in/3` description

Questions / Help
1

Hi! I was reading the docs and I was wondering why the update_in/3 description is different from others. Let me explain.

There are:

  • put_in/2: Puts a value in a nested structure via the given path .

  • put_in/3: Puts a value in a nested structure.

  • get_and_update_in/2: Gets a value and updates a nested data structure via the given path .

  • get_and_update_in/3: Gets a value and updates a nested structure.

  • update_in/2: Updates a nested structure via the given path .

  • update_in/3: Updates a key in a nested structure.

Is there a reason for the description to be different?

Maybe it should be just “Updates a nested structure.” to keep consistency.

1 Like
3

It should be, as you are updating value, not key. Send a PR.

3 Likes
5

I agree. A PR would be very welcome. Consistency in the docs is important.

8 Likes
6

I will do it :blush:

1 Like