Update structs.md #14683
Update structs.md #14683
Conversation
| ## Defining structs | ||
|
|
||
| To define a struct, the `defstruct/1` construct is used: | ||
| To define a struct, the [`defstruct/1`](https://hexdocs.pm/elixir/Kernel.html#defstruct/1) construct is used: |
There was a problem hiding this comment.
I would say that this is bug in ExDoc if it is not autodiscovered. But IMHO that should not use absolute link to HexDocs. I think that there is some other way to cross-link, but someone more familiar with ExDoc need to point that out.
There was a problem hiding this comment.
We do autolink and it works currently as is: https://hexdocs.pm/elixir/structs.html
|
Hi @ice-cap0, this is part of the getting started guide. it is meant to be a gentle introduction rather than a complete reference. Could you instead move this to |
|
Gonna give a lil pushback here to argue that these things should be mentioned in Getting Started because:
|
|
Perhaps we can add a section about dynamically updating structs, using |
| ```elixir | ||
| iex> john = %User{name: "John", age: 27} | ||
| %User{age: 27, name: "John"} | ||
| iex> struct!(john, name: "Jane", age: 30) |
There was a problem hiding this comment.
I feel like this example is kind of wrong, you should probably use the map update syntax when you know exactly which fields are going to be updated, like in this case.
| iex> struct!(john, name: "Jane", age: 30) | |
| iex> %{john | name: "Jane", age: 30} |
The second example seems more correct to me because the update comes from a variable.
There was a problem hiding this comment.
That's a good point. Also, data from external sources typically means string keys and may require casting, which isn't tackled by structs by default.
There was a problem hiding this comment.
Yeah I agree with both points. Will update. I personally just discovered you can use struct/2 to update structs yesterday after like 5 years doing Elixir :D
|
💚 💙 💜 💛 ❤️ |
4 participants
Adds missing documentation for
Kernel.struct/2and warnings about breaking structs withMapfunctions.Changes:
Kernel.struct/2usageMap.put/3andMap.merge/2Why: The current docs were missing
Kernel.struct/2which is crucial for merging data.