Like many services, Inch CI provides badges to be embedded in READMEs. That way, visitors and potential contributors of your GitHub projects can immediately see that you value documenting your code.
Hopefully it's mostly green when you're reading this.
Inch evaluates inline-docs and reports grades for each class, module and method. The badges display up to four segments, with each segment representing one of these grades:
ASeems perfect, Inch can't make any suggestions for improvement.
BProperly documented. Inch is able to make (pedantic) suggestions for minor improvements.
CSomething seems off here, like a mispelled parameter name. Please take a look.
UUndocumented. This is assigned a special grade, since almost every project has parts that are not in need of explicit documentation.
The widths of the individual segments represent the distribution of the grades.
In the above example, you can see a grade distribution that tells you four things:
This provides a lot more insight than an overall grade could and does a much better job of painting the bigger picture.