<commit_before>_ = require "underscore"

# Use this as a mixin for classes that have words to name / translate.
# See _./itemerge.coffee_ as an example of what the nested @words hash is like.

# Suppose an attribute of "name" - quite usual, often the only (necessary).
# Thus expect that `@words.expect is ['name']`, while the actual words data
# must be in conformance with each `@words.data[id][attribute][language]`
# set to a `["Hermes Name", "Modern Name"]` array.

# **`Hermes Name`** is the Hellenistic Astrology (System of Hermes) name.
# If the **`Hermes Name`** is `true`, rather than a string, it means that
# the **`Modern Name`** is equivalent to the original Greek word.
# If it's `null` (with other languages), then it hasn't been revised,
# meaning it's possibly sub-optimal for Hellenistic Astrology use.
# A value of false means it's deemed unfit for Hellenistic Astrology.

# In order to be `@translatable` a collection needs to have its initial data
# in one or more hashes - look at ./itemerge.coffee and how `@planets.the`
# and `@planets.attributes.use` are expected in addition to `@words`.
# There can be more than one initialization hashes, but a single `@words`
# data set for translation - basically the collection as a whole.

# Example usage within the `constructor` / `initialize`:

#     _.extend @, polyglot.ensure<commit_msg>[Finishes #35735589] update polyglot's literate docs<commit_after>_ = require "underscore"

# Use this as a mixin for classes that have words to name / translate.
# See [lin](http://astrolet.github.com/lin/)'s `Ensemble`
# as an example of what the `@words` object must be like.
# For a more varied example of words / localization data, see
# [there](http://astrolet.github.com/there/)'s
# [care](http://astrolet.github.com/there/annotations/care.html).

# Suppose an attribute of "name" - quite usual, often the only (necessary).
# Thus expect that `@words.expect is ['name']`, while the actual words data
# must be in conformance with each `@words.data[id][attribute][language]`
# set to a `["Hermes Name", "Modern Name"]` array.

# **`Hermes Name`** is the Hellenistic Astrology (System of Hermes) name.
# If the **`Hermes Name`** is `true`, rather than a string, it means that
# the **`Modern Name`** is equivalent to the original Greek word.
# If it's `null` (with other languages), then it hasn't been revised,
# meaning it's possibly sub-optimal for Hellenistic Astrology use.
# A value of false means it's deemed unfit for Hellenistic Astrology.

# In order to be `@translatable` a collection needs to have its initial data
# set up.  Look at [lin](http://astrolet.github.com/lin)'s
# [Ensemble](http://astrolet.github.com/lin/annotations/ensemble.html)
# - more pecifically how `@planets.the` and `@planets.attributes.use`
# are expected in addition to `@words`.
# There can be more than one initialization objects, but a single `@words`
# data set for translation - basically the collection as a whole.

# Example usage within the `constructor` / `initialize`:

#     _.extend @, polyglot.ensure
{'fraction_non_alphanumeric': 0.11716710182767624, 'fraction_numerical': 0.0026109660574412533, 'mean_word_length': 4.415194346289753, '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': '6497069', 'n_tokens_mistral': 941, 'n_tokens_neox': 900, 'n_words': 398}