Add Inch CI to test documentation quality#5
Open
davejlong wants to merge 1 commit into
Open
Conversation
Owner
|
@davejlong I'm not familiar with Inch CI; what exactly does it do/check? |
Author
|
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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.addwill need to be run on the origin repo.