search

benfalk / crystal_forge

API Blueprint & RAML Stub Server
MIT License
6 stars 0 forks source link

Code Documentation & Coverage #11

Closed benfalk closed 9 years ago

benfalk commented 9 years ago

Need to settle on a unified style of commenting and find a way to enforce some of quality and quanity, or lack there of, in the source. May put it in with the default rake task to help ensure it stays at the level the project needs to be at.

benfalk commented 9 years ago

Opting to use 'yardstick' to check documentation coverage. It seems to mirror pretty well with the badge health. Currently setting it to pass with the current percentage of documentation and hope to raise it higher with refactorings and deeper code reviews

Here is the commit that did this work: https://github.com/benfalk/crystal_forge/commit/75a8e8125dc807e2ed63dae189391607e076b743

benfalk commented 9 years ago

:point_up: as a side note this also means that the documentation style is yard