<commit_before># [TomParse](http://rubyworks.github.io//tomparse)

[![Version](https://img.shields.io/gem/v/tomparse.svg)](https://rubygems.org/gems/tomparse)
[![Build Status](https://secure.travis-ci.org/rubyworks/tomparse.png)](http://travis-ci.org/rubyworks/tomparse)
[![Issues](https://img.shields.io/github/issues-raw/badges/shields.svg)](https://github.com/rubyworks/tomparse/issues)

TomParse is a TomDoc parser for Ruby. It provides no other functionality than
to take a code comment and parse it in to a convenient object-oriented
structure in accordance with the TomDoc standard. See [TomDoc](https://github.com/mojombo/tomdoc)
for more information about the TomDoc format.


## Instructions

### Usage

The primary interface is the `TomParse.parse` method. It will parse the
comment and return a `TomParse::TomDoc` instance.

    TomParse.parse(comment)  #=> TomParse::TomDoc
<commit_msg>Quick fix again and again. :admin:<commit_after># [TomParse](http://rubyworks.github.io//tomparse)

[![Version](https://img.shields.io/gem/v/tomparse.svg)](https://rubygems.org/gems/tomparse)
[![Build Status](https://secure.travis-ci.org/rubyworks/tomparse.png)](http://travis-ci.org/rubyworks/tomparse)
[![Issues](https://img.shields.io/github/issues-raw/rubyworks/facets.svg)](https://github.com/rubyworks/tomparse/issues)

TomParse is a TomDoc parser for Ruby. It provides no other functionality than
to take a code comment and parse it in to a convenient object-oriented
structure in accordance with the TomDoc standard. See [TomDoc](https://github.com/mojombo/tomdoc)
for more information about the TomDoc format.


## Instructions

### Usage

The primary interface is the `TomParse.parse` method. It will parse the
comment and return a `TomParse::TomDoc` instance.

    TomParse.parse(comment)  #=> TomParse::TomDoc

{'fraction_non_alphanumeric': 0.1411312465678199, 'fraction_numerical': 0.0, 'mean_word_length': 5.093645484949833, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 5, 'https://': 12, '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': '1806055', 'n_tokens_mistral': 593, 'n_tokens_neox': 568, 'n_words': 143}