Merge pull request #545 from SuffolkLITLab/copilot/fix-329

Add comprehensive SMS notification style guidelines

Author: nonprofittechy

docs/components/ALToolbox/Addup.md

@@ -0,0 +1,78 @@
+# Table of Contents
+
+* [ALToolbox.Addup](#ALToolbox.Addup)
+  * [Addup](#ALToolbox.Addup.Addup)
+    * [\_\_init\_\_](#ALToolbox.Addup.Addup.__init__)
+    * [g](#ALToolbox.Addup.Addup.g)
+
+---
+sidebar_label: Addup
+title: ALToolbox.Addup
+---
+
+<a id="ALToolbox.Addup.Addup"></a>
+
+## Addup Objects
+
+```python
+class Addup()
+```
+
+Utility class for calculating sums of numeric fields across DAList objects.
+
+This class provides functionality to sum specific numeric fields from all
+items in a Docassemble DAList, which is useful for financial calculations
+and data aggregation in legal document automation.
+
+<a id="ALToolbox.Addup.Addup.__init__"></a>
+
+#### \_\_init\_\_(listName, varName)
+
+```python
+def __init__(listName, varName)
+```
+
+Initialize the Addup calculator and compute the sum immediately.
+
+**Arguments**:
+
+- `self` - The instance being initialized.
+- `listName` - A DAList object containing items with numeric fields.
+- `varName` _str_ - The name of the field to sum across all list items.
+
+<a id="ALToolbox.Addup.Addup.g"></a>
+
+#### g(listName, varName)
+
+```python
+def g(listName, varName) -> float
+```
+
+Calculate the sum of a specific numeric field across all items in a DAList.
+
+Iterates through each item in the provided DAList, extracts the specified
+field value, and adds all values together. Raises an error if the sum is 0,
+which indicates the field was not found or contained no numeric values.
+
+**Arguments**:
+
+- `listName` - A DAList object containing items with numeric fields.
+- `varName` _str_ - The name of the field to sum across all list items.
+  
+
+**Returns**:
+
+- `float` - The sum of all values for the specified field.
+  
+
+**Raises**:
+
+- `DAValidationError` - If the sum is 0, indicating the field was not found
+  or contained no numeric values.
+  
+
+**Example**:
+
+  &gt;&gt;&gt; addup = Addup(income_list, &quot;monthly_amount&quot;)
+  &gt;&gt;&gt; # Returns sum of monthly_amount fields from all items in income_list
+

docs/components/ALToolbox/ThreePartsDate.md

@@ -0,0 +1,165 @@
+# Table of Contents
+
+* [ALToolbox.ThreePartsDate](#ALToolbox.ThreePartsDate)
+  * [check\_empty\_parts](#ALToolbox.ThreePartsDate.check_empty_parts)
+  * [ThreePartsDate](#ALToolbox.ThreePartsDate.ThreePartsDate)
+    * [validate](#ALToolbox.ThreePartsDate.ThreePartsDate.validate)
+    * [transform](#ALToolbox.ThreePartsDate.ThreePartsDate.transform)
+    * [default\_for](#ALToolbox.ThreePartsDate.ThreePartsDate.default_for)
+  * [BirthDate](#ALToolbox.ThreePartsDate.BirthDate)
+    * [validate](#ALToolbox.ThreePartsDate.BirthDate.validate)
+
+---
+sidebar_label: ThreePartsDate
+title: ALToolbox.ThreePartsDate
+---
+
+<a id="ALToolbox.ThreePartsDate.check_empty_parts"></a>
+
+#### check\_empty\_parts(item: str, default\_msg="{} is not a valid date")
+
+```python
+def check_empty_parts(item: str,
+                      default_msg="{} is not a valid date") -> Optional[str]
+```
+
+Validate a date string in MM/DD/YYYY format and return specific error messages for missing parts.
+
+Analyzes a date string separated by forward slashes to determine which parts
+(month, day, year) are missing and returns a helpful error message indicating
+what needs to be entered. Currently only handles US date format.
+
+**Arguments**:
+
+- `item` _str_ - The date string to validate, expected in MM/DD/YYYY format.
+- `default_msg` _str, optional_ - Default error message template for invalid dates.
+  Defaults to &quot;\{\} is not a valid date&quot;.
+  
+
+**Returns**:
+
+  Error message if validation fails, None if date is valid.
+  Returns None when the date is complete and valid, otherwise returns
+  a localized error message indicating which parts need to be entered.
+  
+
+**Example**:
+
+  &gt;&gt;&gt; check_empty_parts(&quot;12//2023&quot;)
+  &quot;Enter a day&quot;
+  &gt;&gt;&gt; check_empty_parts(&quot;//&quot;)
+  &quot;Enter a month, a day, and a year&quot;
+  &gt;&gt;&gt; check_empty_parts(&quot;12/25/2023&quot;)
+  None
+
+<a id="ALToolbox.ThreePartsDate.ThreePartsDate"></a>
+
+## ThreePartsDate Objects
+
+```python
+class ThreePartsDate(CustomDataType)
+```
+
+<a id="ALToolbox.ThreePartsDate.ThreePartsDate.validate"></a>
+
+#### validate(cls, item: str)
+
+```python
+@classmethod
+def validate(cls, item: str) -> bool
+```
+
+Validate a date string in MM/DD/YYYY format.
+
+**Arguments**:
+
+- `item` _str_ - The date string to validate.
+  
+
+**Returns**:
+
+- `bool` - True if valid or empty, raises DAValidationError if invalid.
+  
+
+**Raises**:
+
+- `DAValidationError` - If the date string is invalid or cannot be parsed.
+
+<a id="ALToolbox.ThreePartsDate.ThreePartsDate.transform"></a>
+
+#### transform(cls, item)
+
+```python
+@classmethod
+def transform(cls, item) -> Optional[datetime]
+```
+
+Transform a date string into a datetime object.
+
+**Arguments**:
+
+- `item` - The date string to transform.
+  
+
+**Returns**:
+
+  datetime or None: The parsed datetime object, or None if empty.
+
+<a id="ALToolbox.ThreePartsDate.ThreePartsDate.default_for"></a>
+
+#### default\_for(cls, item)
+
+```python
+@classmethod
+def default_for(cls, item) -> Optional[str]
+```
+
+Convert a datetime object to MM/dd/yyyy format string.
+
+**Arguments**:
+
+- `item` - The datetime object to format.
+  
+
+**Returns**:
+
+  str or None: The formatted date string, or None if empty.
+
+<a id="ALToolbox.ThreePartsDate.BirthDate"></a>
+
+## BirthDate Objects
+
+```python
+class BirthDate(ThreePartsDate)
+```
+
+<a id="ALToolbox.ThreePartsDate.BirthDate.validate"></a>
+
+#### validate(cls, item: str)
+
+```python
+@classmethod
+def validate(cls, item: str) -> bool
+```
+
+Validate a birth date string ensuring it&#x27;s a valid past date.
+
+Validates that the input is a properly formatted date string in MM/DD/YYYY
+format that represents a date on or before today and after the year 1000.
+Empty or None values are considered valid.
+
+**Arguments**:
+
+- `item` _str_ - The birth date string to validate in MM/DD/YYYY format.
+  
+
+**Returns**:
+
+  True if the date is valid, otherwise raises DAValidationError.
+  
+
+**Raises**:
+
+- `DAValidationError` - If the date is invalid, improperly formatted,
+  or in the future.
+