Only report top level functions that are exposed

ContaSystemer / elm-review-no-missing-documentation

elm-review rule to enforce documentation for every top level declaration

BSD 3-Clause "New" or "Revised" License

0 stars 2 forks source link

Only report top level functions that are exposed #1

Open MartinSStewart opened 4 years ago

MartinSStewart commented 4 years ago

Cool elm-review package!

One suggestion I have is that you only check top level functions that are exposed, rather than check all top level functions. I find that it's time consuming to write documentation for every function and since unexposed functions won't be used much (they can only be accessed from within the module after all), the extra effort isn't worth it.

akoppela commented 3 years ago

@MartinSStewart Thanks for feedback. Would you like to submit a PR for that?