dhall-docs doesn’t impose any restrictions on the format of the comments for documentation, meaning that any comment will be included.
We should define a convention on the format of these
dhall-docs comments because:
- It will give control to the user to separate internal comments from documentation comments.
- It will solve some issues relevant to indentation on Markdown.
Here you can read my first proposal for this specification.
It is currently a draft PR here, meaning that you can participate there if you want to suggest an improvement or if you see some ambiguity that you’d like to be resolved.
Please take a look at the proposal and give me your thoughts about it. After defining it I will work on the implementation.