guard-yardstick
guard-yardstick will automatically check your code for missing yardocs
Installation
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
After correctly installing the gem initialize your Guardfile as follows.
$ bundle exec guard init yardstick
Please read the Guard usage documentation for further details.
Options
There is currently only a single option that can be passed to this guard. all_on_start which is true by default.
guard :yardstick, all_on_start: false 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