Drasil icon indicating copy to clipboard operation
Drasil copied to clipboard

Add haddock syntax guildline in Drasil Wiki

Open cd155 opened this issue 2 years ago • 1 comments

Drasil source code uses Haddock to generate code documentation. Haddock has a specific format to change Haskell's comments into a Haddock document. For example, the syntax below

-- |

Website https://haskell-haddock.readthedocs.io/en/latest/markup.html, gives the example and instructions. I think this information better included in the Drasil Wiki.

cd155 avatar Aug 18 '22 20:08 cd155

I agree @cd155 that this information would be useful. We could add it to the Contributor's Guide.

smiths avatar Aug 18 '22 20:08 smiths

I added this part in Contributor's Guide - Coding Style

cd155 avatar Sep 19 '22 16:09 cd155