Hi! 

I have no idea if this is really even possible, or what the syntax could 
be, but I am curious to hear the reception to the proposal of having 
documentation for Struct fields.

You can already add an `@doc` attribute to `defstruct`.

This curiosity somewhat stems from being able to show docs for struct 
fields when providing completion candidates for intellisense programs like 
an LSP server.

The current struct syntax does not seem to lend itself well to something 
like this, but if this proposal sounds any bit interesting, I'm sure we 
could think of something.

Also, if you can already do this and I somehow missed it after 5 years of 
being in this community, please correct me 😅

- Mitch

PS. Having already typed this, it could be possible maybe if the `@doc` 
attribute could be shaped like

```elixir
@doc struct: "i'm a stuct",
            fields: [
              foo: "I'm the foo field!",
              bar: "I'm the bar field!"
           ]
defstruct foo: nil, bar: nil
```

-- 
You received this message because you are subscribed to the Google Groups 
"elixir-lang-core" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to elixir-lang-core+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/elixir-lang-core/f5a7fc37-865c-4c92-b8c9-485f46183700n%40googlegroups.com.

Reply via email to