Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

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

Closed
jasnow opened this Issue · 7 comments

3 participants

@jasnow

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)?

Thanks

@ghost

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

@jasnow

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

@ghost
@jasnow

okay

@samwgoldman

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

http://www.confreaks.com/videos/893-railsconf2012-sustainable-productivity-with-rails

@xaviershay
Owner

Fair point, I will add something to address this.

@xaviershay xaviershay closed this in 49bc805
@xaviershay
Owner

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.