What Erlang/BEAM related stuff are you doing?

garazdawi · October 20, 2021, 8:12am

My latest itch that I’m scratching is to improve the documentation support in Erlang LS.

github.com/erlang-ls/erlang_ls

Eep 48 markdown

erlang-ls:main ← garazdawi:eep-48-markdown

opened 04:02PM - 01 Oct 21 UTC

garazdawi

+1076 -146

### Description This PR adds a markdown rendering backend for EEP-48 style do…cumentation. TODO: - [x] Create markdown renderer - [x] Fetch docs for types - [x] Use edoc doc chunks renderer when available - [x] Use edoc doc chunks renderer when available - [x] Add docs to type completion - [x] Extract clauses when docs do not exist - [x] Check all versions of file for eep48 docs before resorting to edoc (i.e. if developing OTP and autocompleting the lists module) - [ ] Fix multiline code examples in emacs. See `atom_to_list/1` for example. - [ ] Add testing... In VS code the change looks like this. Before: ![before_els_markdown](https://user-images.githubusercontent.com/111762/135651562-89de19d7-54c2-4d52-85f4-9f8b779ae026.png) After: ![after_els_markdown](https://user-images.githubusercontent.com/111762/135651593-9aa61be0-2197-49c4-a83c-f058c07ebe36.png) I'm opening this as a draft to get some feedback if this is something you want. If so, there is more work to be done in order to add tests and also check that is actually renders the markdown nicely in most of the editors.

For anyone working with Erlang I think this will be a great improvement!