guard-yardstick
guard-yardstick will automatically check your code for missing yardocs
Installation
Please make sure to have Guard installed before continue.
Add guard-yardstick to your Gemfile:
group :development do
gem 'guard-yardstick'
end
And then execute:
$ bundle
Or install it yourself as:
$ gem install guard-yardstick
Usage
Please read the Guard usage documentation.
Options
You can pass some options in Guardfile like the following example:
guard :yardstick, all_on_start: false, cli: ['app/**/*.rb', 'lib/**/*.rb'] do
# ...
end
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request