segiddins/inch_by_inch


A rake task to pretty-print documentation violations.

License: MIT

Language: Ruby


InchByInch

Build Status Gem Version

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:

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:

# 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.

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 code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Project Statistics

Sourcerank 6
Repository Size 12.7 KB
Stars 6
Forks 1
Watchers 1
Open issues 0
Dependencies 21
Contributors 3
Tags 2
Created
Last updated
Last pushed

Top Contributors See all

Samuel Giddins Antoine Cœur ReadmeCritic

Packages Referencing this Repo

inch_by_inch
A rake task to pretty-print documentation violations.
Latest release 1.0.1 - Updated - 6 stars

Recent Tags See all

v1.0.1 April 25, 2018
v1.0.0 December 08, 2015

Something wrong with this page? Make a suggestion

Last synced: 2018-04-25 03:40:49 UTC

Login to resync this repository