elm-style-guide icon indicating copy to clipboard operation
elm-style-guide copied to clipboard

Published 20 hours ago • verified publisher icon NoRedInk

Automatic tool?

Open mristin opened this issue 6 years ago • 4 comments

Hi NRI,

Thank you very much for writing this style guide and sharing it with the wider community! Do you know if there is a tool to automatically check the comments akin to pydocstyle for Python? For example, a tool that can ensure that each file, all public functions and records are documented etc.

mristin avatar Aug 03 '18 07:08 mristin

Hey @mristin, we use https://github.com/ento/elm-doc to do that.

Arkham avatar Oct 24 '19 08:10 Arkham

@Arkham thanks for the pointer. We needed a tool to check the documentation in the code rather than generate the code.

We finally developed https://github.com/Parquery/elm-docstyle. There is still no "official" tool like that one, right?

mristin avatar Oct 24 '19 09:10 mristin

Oh, that's great! The tool I linked has a --validate flag that does that, but it's not nearly as thorough as yours :)

Arkham avatar Oct 24 '19 09:10 Arkham

I created an issue for elm-doc: https://github.com/ento/elm-doc/issues/66

It would make sense to merge elm-docstyle with elm-doc.

mristin avatar Oct 24 '19 09:10 mristin