Skip to content

Commit

Permalink
Add a bit of haddock style guide. Need to add more.
Browse files Browse the repository at this point in the history
  • Loading branch information
thealmarty committed Aug 10, 2022
1 parent bc9cdcd commit 4be6874
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion STYLEGUIDE.adoc
Expand Up @@ -82,7 +82,7 @@ The reasoning is essentially the same as for type signatures. We've got used to

=== Write Haddock

Every top-level exported binding should have Haddock. Non-exported bindings should probably have Haddock too.
Every top-level exported binding should have Haddock. Non-exported bindings should probably have Haddock too. See https://haskell-haddock.readthedocs.io/en/latest/markup.html#markup[this section] on using markup to make the Haddock more helpful.

Put the module’s haddock comment _right_ above the `module M where` line, and below the PRAGMAs.

Expand Down

0 comments on commit 4be6874

Please sign in to comment.