Skip to content
This repository has been archived by the owner on Aug 23, 2018. It is now read-only.

Inline documentation of function params #165

Open
heath opened this issue Jun 1, 2017 · 1 comment
Open

Inline documentation of function params #165

heath opened this issue Jun 1, 2017 · 1 comment

Comments

@heath
Copy link

heath commented Jun 1, 2017

It could potentially be nice to have inline documentation of function parameters...

Maybe it is better practice to create a type alias for each and every parameter, but sometimes it's more convenient to add inline documentation using this style of documentation:

foo : bar -- documentation for the bar param
   -> baz -- documentation for the baz param
   -> qux

Haddock does a nice job of generating documentation for functions with this method, see e.g.:
https://hackage.haskell.org/package/bytestring-0.10.8.1/docs/Data-ByteString.html#v:breakSubstring

@process-bot
Copy link

Thanks for the issue! Make sure it satisfies this checklist. My human colleagues will appreciate it!

Here is what to expect next, and if anyone wants to comment, keep these things in mind.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants