Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automatic tool? #13

Open
mristin opened this issue Aug 3, 2018 · 4 comments
Open

Automatic tool? #13

mristin opened this issue Aug 3, 2018 · 4 comments

Comments

@mristin
Copy link

mristin commented Aug 3, 2018

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
Copy link
Contributor

Arkham commented Oct 24, 2019

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

@mristin
Copy link
Author

mristin commented Oct 24, 2019

@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
Copy link
Contributor

Arkham commented Oct 24, 2019

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
Copy link
Author

mristin commented Oct 24, 2019

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

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

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

No branches or pull requests

2 participants