search

skippyPeanutButter / yaml_bot

Validate the content of a yaml file according to a set of rules
MIT License
3 stars 0 forks source link

Add class documentation to YamlBot classes #27

Closed skippyPeanutButter closed 6 years ago

skippyPeanutButter commented 7 years ago

Work to address https://github.com/skippyPeanutButter/yaml_bot/issues/17

skippyPeanutButter commented 7 years ago

@samrocketman @elliotweiser Please review

skippyPeanutButter commented 7 years ago

@samrocketman You can generate documentation from this using the yard gem.

gem install yard

# run yardoc from the root directory of the project
yardoc

# run a server to see the documentation that will be generated from it
yard server

Basically, the way the documentation looks when you run yard server is how it will look when you publish the gem to rubygems.org and docs are generated for it on http://www.rubydoc.info/