gleam icon indicating copy to clipboard operation
gleam copied to clipboard

Support EEP 48 (compiling code documentation for use in Erlang etc)

Open lpil opened this issue 4 years ago • 5 comments

lpil avatar Jan 23 '21 22:01 lpil

Better yet, we should support EEP 48 so that our documentation can be viewed from Erlang, Elixir, LFE, etc shells. The actual organization and storage of this information will be trivial if tedious, but the larger challenge will lie in updating the parser to retain //// and /// comments instead of discarding them.

J3RN avatar Dec 31 '21 06:12 J3RN

Agreed, the parser rework will be the fiddly bit.

RE EEP 48, last I looked into this there was some suggestion of Erlang using a -doc("..."). attribute, I wonder if that is usable yet.

lpil avatar Dec 31 '21 10:12 lpil

It appears that EDoc supports special %% @doc ... comments, alongside other more specific constructs such as %% @author ..., which it can then compile into the EEP 48-compliant "chunks".

J3RN avatar Dec 31 '21 18:12 J3RN

Ah here we are, found it -> https://github.com/erlef/build-and-packaging-wg/issues/32

lpil avatar Jan 04 '22 15:01 lpil

Sadly José's Google Doc appears to have been deleted (or else I specifically don't have access 😅) and the EEP hasn't yet been created.

J3RN avatar Jan 04 '22 16:01 J3RN

Closing as we don't have a clear idea of what to do here.

lpil avatar Jul 31 '23 11:07 lpil