Hi everyone,
together with @hcs42 we are currently working on adding support for docstrings to the vim syntax file for Erlang → Update Erlang syntax for recent language changes by jchristgit · Pull Request #58 · vim-erlang/vim-erlang-runtime · GitHub
During the review, it was figured it might be better to poll the community on the following question: Should markdown be highlighted by default in Erlang docstrings? The remainder of the docstring will be highlighted as a comment (this is configurable), markdown elements will be highlighted the same way as in a regular markdown file. However, this 1. comes at a slight (barely noticeable for me) performance penalty to opening files and scrolling (more noticeable), and 2. assumes that people use markdown, which might be unexpected since other formats are supported, too.
Regardless of the outcome, this can be configured with one line in the vimrc, let g:erlang_use_markdown_for_docs = 0 | 1.
Elixir’s vim syntax files have this option too, and it’s disabled by default. Admittedly I didn’t know it was an option until I read the syntax file myself. This is why we think having it enabled by default might be useful.
- Should be enabled by default (at a slight performance penalty)
- Should be disabled by default
Thank you for participating!