Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/segiddins/inch_by_inch
A rake task to pretty-print documentation violations.
https://github.com/segiddins/inch_by_inch
Last synced: 25 days ago
JSON representation
A rake task to pretty-print documentation violations.
- Host: GitHub
- URL: https://github.com/segiddins/inch_by_inch
- Owner: segiddins
- License: mit
- Created: 2015-12-05T21:56:50.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2022-02-26T19:27:40.000Z (over 2 years ago)
- Last Synced: 2024-05-02T00:23:47.161Z (6 months ago)
- Language: Ruby
- Homepage:
- Size: 20.5 KB
- Stars: 6
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# InchByInch
[![Build Status](http://img.shields.io/travis/segiddins/inch_by_inch/master.svg?style=flat)](https://travis-ci.org/segiddins/inch_by_inch)
[![Gem Version](http://img.shields.io/gem/v/inch_by_inch.svg?style=flat)](http://badge.fury.io/rb/inch_by_inch)A rake task to make validating your documentation comments as easy as running
a single command.## Installation
Add this line to your application's `Gemfile`:
```ruby
gem 'inch_by_inch'
```And then execute:
$ bundle
Or install it yourself as:
$ gem install inch_by_inch
## Usage
In your `Rakefile`, add the following:
```ruby
# Rakefile
require 'inch_by_inch/rake_task'
InchByInch::RakeTask.new
```## Development
After checking out the repo, run `bin/setup` to install dependencies. You can
also run `bin/console` for an interactive prompt that will allow you to
experiment.To install this gem onto your local machine, run `rake install`. To
release a new version, update the version number in `version.rb`, commit,
and then run `rake release`, which will create a git tag for the version, push
git commits and tags, and push the `.gem` file to
[rubygems.org](https://rubygems.org).## Contributing
Bug reports and pull requests are welcome on GitHub at
https://github.com/segiddins/inch_by_inch. This project is intended to be a
safe, welcoming space for collaboration, and contributors are expected to adhere
to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.## License
The gem is available as open source under the terms of the [MIT
License](http://opensource.org/licenses/MIT).