diff --git a/docs/components/AssemblyLine/al_courts.md b/docs/components/AssemblyLine/al_courts.md index eeb5201b5..afbdecbf5 100644 --- a/docs/components/AssemblyLine/al_courts.md +++ b/docs/components/AssemblyLine/al_courts.md @@ -183,14 +183,14 @@ Create a new courtloader object. #### all\_courts() ```python -def all_courts() -> List[Dict[int, str]] +def all_courts() -> List[Tuple[int, str]] ``` Return a list of all courts in the spreadsheet. **Returns**: - List[Dict[int, str]]: List of all ALCourt instances without filtering. + List[Tuple[int, str]]: List of tuples where each tuple contains (dataframe_index, display_value). The dataframe_index (int) can be used with as_court() to retrieve the full court object. The display_value (str) is the court's name or other display column value. @@ -292,14 +292,15 @@ def matching_courts_in_county( display_column: str = "name", search_string: Optional[str] = None, search_columns: Optional[Union[List[str], str]] = None -) -> List[Dict[int, str]] +) -> List[Tuple[int, str]] ``` Retrieve a list of all courts in the specified county. This function fetches courts suitable for displaying as a drop-down or radio button list -in Docassemble. The results are dictionaries where the key is the index in the dataframe, -useful for retrieving the court's full details later using the as_court() method. +in Docassemble. The results are tuples where the first element is the dataframe index +(useful for retrieving the court's full details later using the as_court() method) and +the second element is the display value from the specified display_column. **Arguments**: @@ -313,7 +314,7 @@ useful for retrieving the court's full details later using the as_court() m **Returns**: - List[Dict[int, str]]: List of dictionaries representing matching courts. + List[Tuple[int, str]]: List of tuples where each tuple contains (dataframe_index, display_value). The dataframe_index (int) can be used with as_court() to retrieve the full court object. The display_value (str) is the court's name or other display column value. @@ -326,12 +327,12 @@ def filter_courts( display_column: str = "name", search_string: Optional[str] = None, search_columns: Optional[Union[List[str], str]] = None -) -> List[Dict[int, str]] +) -> List[Tuple[int, str]] ``` -Return a filtered subset of courts represented as a list of dictionaries. +Return a filtered subset of courts represented as a list of tuples. -Each dictionary has the format \{index: name\}, where "index" refers to the dataframe index and "name" +Each tuple has the format (index, display_value), where "index" refers to the dataframe index and "display_value" is determined by the `display_column`. **Arguments**: @@ -347,7 +348,7 @@ is determined by the `display_column`. **Returns**: - List[Dict[int, str]]: List of dictionaries representing filtered courts. + List[Tuple[int, str]]: List of tuples where each tuple contains (dataframe_index, display_value). The dataframe_index (int) can be used with as_court() to retrieve the full court object. The display_value (str) is the court's name or other display column value. diff --git a/docs/components/AssemblyLine/al_general.md b/docs/components/AssemblyLine/al_general.md index 1fe4cab75..d54b9f491 100644 --- a/docs/components/AssemblyLine/al_general.md +++ b/docs/components/AssemblyLine/al_general.md @@ -64,7 +64,6 @@ * [section\_links](#AssemblyLine.al_general.section_links) * [will\_send\_to\_real\_court](#AssemblyLine.al_general.will_send_to_real_court) * [filter\_letters](#AssemblyLine.al_general.filter_letters) - * [fa\_icon](#AssemblyLine.al_general.fa_icon) * [is\_sms\_enabled](#AssemblyLine.al_general.is_sms_enabled) * [is\_phone\_or\_email](#AssemblyLine.al_general.is_phone_or_email) * [github\_modified\_date](#AssemblyLine.al_general.github_modified_date) @@ -1430,33 +1429,6 @@ Avoid using, this is created for 209A. - `str` - A string of unique letters. - - -#### fa\_icon(icon: str, color: str = "primary", color\_css: Optional[str] = None, size: str = "sm") - -```python -def fa_icon(icon: str, - color: str = "primary", - color_css: Optional[str] = None, - size: str = "sm") -> str -``` - -Return HTML for a font-awesome icon of the specified size and color. You can reference -a CSS variable (such as Bootstrap theme color) or a true CSS color reference, such as 'blue' or -'`DDDDDD`'. Defaults to Bootstrap theme color "primary". - -**Arguments**: - -- `icon` _str_ - The name of the icon to use. See https://fontawesome.com/icons for a list of icons. -- `color` _str_ - The color of the icon. Defaults to "primary". -- `color_css` _Optional[str]_ - A CSS variable or color reference. Defaults to None. -- `size` _str_ - The size of the icon. Defaults to "sm". - - -**Returns**: - -- `str` - HTML for the icon. - #### is\_sms\_enabled() diff --git a/docs/components/AssemblyLine/translation.md b/docs/components/AssemblyLine/translation.md index 03922f9d3..16cd81ed5 100644 --- a/docs/components/AssemblyLine/translation.md +++ b/docs/components/AssemblyLine/translation.md @@ -134,7 +134,7 @@ id: language question: | What language / que idioma? fields: - - Language/idioma: al_interview_languages + - Language/idioma: al_user_language datatype: radio choices: - English: en