search

whitfin / sentix

A cross-platform file watcher for Elixir based on fswatch.
MIT License
16 stars 5 forks source link

Add Inch CI to test documentation quality #5

Open davejlong opened 7 years ago

davejlong commented 7 years ago

Add in Inch CI to ensure that documentation stays at a high quality. I'm not sure if Inch will pick up on the origin automatically or if MIX_ENV=docs mix do deps.get, inchci.add will need to be run on the origin repo.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 100.0% when pulling 2500d29dcce354f30ab913add8ab0abba2d743fa on davejlong:inch-ci into 17d22614fabb809e609ac84c514047c50d4e823a on zackehh:master.

whitfin commented 7 years ago

@davejlong I'm not familiar with Inch CI; what exactly does it do/check?

davejlong commented 7 years ago

Inch is similar to code coverage testing except that it tests that code has documentation. It tests that the documentation describes methods and modules, how to use them and what information needs to be sent into methods. You can see the Inch report for Kitto at http://inch-ci.org/github/kittoframework/kitto