<commit_before># Inch

A documentation measurement tool for Ruby, based on YARD.

TODO: Write a gem description

## Installation

Add this line to your application's Gemfile:

    gem 'inch'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install inch

## Usage

TODO: Write usage instructions here

## Contributing

1. Fork it ( http://github.com/rrrene/inch/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

## TODOs

* Recognize all relevant options in .yardopts file
  * --plugin
  * --no-public
  * --protected
  * --private
  * --no-private
  * --[no-]api API
* Separate CLI::Command responsibilities into Command::Context for object
  filtering/manipulation and Command::Output for presentation
* Generalize filter options for visible code objects
  (adapt from YARD::CLI::Yardoc)
* Update `inch show` to display natural language descriptions of the detected
  roles. Maybe provide current version of show as `inch inspect`.
* Add support for multiple method signatures for methods
  (realized via the @overload tag in YARD)

## License

Inch is released under the MIT License. See the LICENSE file for further details.

For YARD's licensing, see https://github.com/lsegal/yard<commit_msg>Update Todos in README<commit_after># Inch

A documentation measurement tool for Ruby, based on YARD.

TODO: Write a gem description

## Installation

Add this line to your application's Gemfile:

    gem 'inch'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install inch

## Usage

TODO: Write usage instructions here

## Contributing

1. Fork it ( http://github.com/rrrene/inch/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

## TODOs

* Recognize all relevant options in .yardopts file
  * --plugin
  * --no-public
  * --protected
  * --private
  * --no-private
  * --[no-]api API
* Generalize filter options for visible code objects
  (adapt from YARD::CLI::Yardoc)
* Update `inch show` to display natural language descriptions of the detected
  roles. Maybe provide current version of show as `inch inspect`
* Add support for multiple method signatures for methods
  (realized via the @overload tag in YARD)
* Add some kind of "pedantic" mode that suggests even "okay" looking objects if they don't meet all the criteria

## License

Inch is released under the MIT License. See the LICENSE file for further details.

For YARD's licensing, see https://github.com/lsegal/yard
{'fraction_non_alphanumeric': 0.08656283955088737, 'fraction_numerical': 0.003621876131836291, 'mean_word_length': 3.737564322469983, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5718469', 'n_tokens_mistral': 818, 'n_tokens_neox': 785, 'n_words': 359}