Skip to content


Subversion checkout URL

You can clone with
Download ZIP


Suggestion: Explain what type of documentation are you looking for #34

jasnow opened this Issue · 7 comments

3 participants


Thanks so much for your tool.

Did not know enough about how to fix the documentation checks so turned them off (--no-doc) for now.

Can you please add something to the README or the tool output to explain what to do (template, example, URL)?



I use TomDoc, which seems to be sufficient. I'm guessing any sort of documentation that uses comments like TomDoc does would suffice.


if you gave the above link as part of the missing doc error message that would have helped me to fix it. Thanks.




Xavier motivated and gave an example of the comments in his 2012 RailsConf talk. I think that might help?


Fair point, I will add something to address this.

@xaviershay xaviershay closed this in 49bc805

Please let me know if that commit is sufficient, or if it could be improved. Thanks for the suggestion!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.