<commit_before># ApiTommy

ApiTommy is an opinionated little tool used to generate a wiki page documenting your APIs based on Rails/Rails-api.

Basically, you document your classes using a standard. There is no modification in your code.
You then run this tool and it will automatically generate and update your github wiki.

## Installation

Add this line to your application's Gemfile:

    gem 'api_tommy'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install api_tommy

## Usage

Here is the requirements in order to have an happy tommy (pun intended):

* The better place to document your API is your controllers.
* Each class/method is documented using [TomDoc](http://tomdoc.org/).
* For the class comments, here is the usage of each [TomDoc](http://tomdoc.org/) section:
  * Description: Will describe your API and the returned objects
  * Returns: Not used.
  * Arguments: Will describe each field of your objects
  * Examples: Will provide examples of your object
  * Raises: Not used.
* For the method comments, here is the usage of each [TomDoc](http://tomdoc.org/) section:
  * Description: Will describe your method with its constraints. The first sentence will be used<commit_msg>Fix typo<commit_after># ApiTommy

ApiTommy is an opinionated little tool used to generate a wiki page documenting your APIs based on Rails/Rails-api.

Basically, you document your classes using a standard. There is no modification in your code.
You then run this tool and it will automatically generate and update your github wiki.

## Installation

Add this line to your application's Gemfile:

    gem 'api_tommy'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install api_tommy

## Usage

Here is the requirements in order to have an happy tommy (pun intended):

* The best place to document your API is your controllers.
* Each class/method is documented using [TomDoc](http://tomdoc.org/).
* For the class comments, here is the usage of each [TomDoc](http://tomdoc.org/) section:
  * Description: Will describe your API and the returned objects
  * Returns: Not used.
  * Arguments: Will describe each field of your objects
  * Examples: Will provide examples of your object
  * Raises: Not used.
* For the method comments, here is the usage of each [TomDoc](http://tomdoc.org/) section:
  * Description: Will describe your method with its constraints. The first sentence will be used
{'fraction_non_alphanumeric': 0.0648870636550308, 'fraction_numerical': 0.0, 'mean_word_length': 3.9918032786885247, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, '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': '3561290', 'n_tokens_mistral': 657, 'n_tokens_neox': 632, 'n_words': 340}