Dhall-docs comments format

#1

Hi folks!

Currently 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:

  1. It will give control to the user to separate internal comments from documentation comments.
  2. 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.

4 Likes
#2

Hi! Last week we wrote a comment’s format specification for dhall-docs comments. You can find it here.

If you’d like to test it, you should build the tool from the repository since it’s not release yet (it will soon)

1 Like