Automatic tool?

[mristin]

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.

[Arkham]

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

[mristin]

@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?

[Arkham]

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

[mristin]

I created an issue for elm-doc: ento/elm-doc#66

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