-
Notifications
You must be signed in to change notification settings - Fork 0
Home
This is my attempt on having decent documentation to go with my code. If you have any suggestions on any revisions to this wiki please put it in issues under the Documentation
tag. I will try to keep this wiki as up-to-date as possible as features are revised / added.
Methods are organized into families based on function to make documentation easier to navigate. Functions within the same family all serve similar functions but based off of different parameters. Functions that are dependent on each other are not always part of the same family (i.e. autoForm() and baseLaw()). See below for the Families.
Family Name | General Function |
---|---|
Sheer Family | Extract data from one expStr to another |
Format Family | Modify data to comply with preset rules |
Legal Family | Modify the rules followed by the legal family |
Division Family | Parses strings based on preset or user given rules |
(There are some exceptions for things that don't fit into families i.e. Overloaded Operators)
Many planned updates are set for this wiki at certain times with the primary wall for these updates being the release of the Alpha version of this project which is the point when update indications will move from individual update names to proper version identifiers.
Addition Name | Description | Planned Release Condition | Completed |
---|---|---|---|
Updates Page | Tracks Updates and defines differences | Alpha Release | ✅ |
Setup Page | Guides installation | Beta Release | ✅ |
FAQ Page | Answers common and simple questions | N/A | ❌ |
Thank you Page | Tributes any contributors1 to this project before release | v1.0.0 Release | ❌ |
contributors1: Anyone who contributes through discussions, issue posts, stars, or other notable method.
Revisions underway
This project is still in very early stages. Documentation will be updated with code to the best of my ability.