<commit_before>Alchemy Annotations
==============================================

<img src="https://raw.githubusercontent.com/SirWellington/alchemy/develop/Graphics/Logo/Alchemy-Logo-v3-name.png" width="200">

[![Build Status](https://travis-ci.org/SirWellington/alchemy-annotations.svg)](https://travis-ci.org/SirWellington/alchemy-annotations)

## "Write what you mean, mean what you write."

# Purpose
**Alchemy Annotations** allow clearer documentation of intent of your code.

It can be used to document intent, expectations, behaviors, structure, and more.

# Why use this

It is much easier for other developers and architects to understand what is going on in the code base when they
know what to look for, and what behavior to expect.

It also allows us to more explicitly document intent and expectations, reducing the chance for human mistake.

For example, by applying the `@StrategyPattern` annotation to a few classes, we know can more easily understand the
relationship between them.


# Download

To use, simply add the following maven dependency.

## Release
```xml
<dependency>
	<groupId>tech.sirwellington.alchemy</groupId>
	<artifactId>alchemy-annotations</artifactId>
	<version>1.2</version>
</dependency>
```
<commit_msg>Updates to the Copy<commit_after>Alchemy Annotations
==============================================

## "Write what you mean, mean what you write."

<img src="https://raw.githubusercontent.com/SirWellington/alchemy/develop/Graphics/Logo/Alchemy-Logo-v3-name.png" width="200">

[![Build Status](https://travis-ci.org/SirWellington/alchemy-annotations.svg)](https://travis-ci.org/SirWellington/alchemy-annotations)


# Purpose
**Alchemy Annotations** allow clearer documentation of intent of your code.

It can be used to document intent, expectations, behaviors, structure, and more.

# Why use this

It is much easier for other developers and architects to understand what is going on in the code base when they
know what to look for, and what behavior to expect.

It also allows us to more explicitly document intent and expectations, reducing the chance for human mistake.

For example, by applying the `@StrategyPattern` annotation to a few classes, we know can more easily understand the
relationship between them.


# Download

To use, simply add the following maven dependency.

## Release
```xml
<dependency>
	<groupId>tech.sirwellington.alchemy</groupId>
	<artifactId>alchemy-annotations</artifactId>
	<version>1.2</version>
</dependency>
```

{'fraction_non_alphanumeric': 0.12905811623246494, 'fraction_numerical': 0.004809619238476954, 'mean_word_length': 5.383631713554987, 'pattern_counts': {'":': 0, '<': 21, '<?xml version=': 0, '>': 21, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 2}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1104902', 'n_tokens_mistral': 730, 'n_tokens_neox': 666, 'n_words': 255}