Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions docs/components/AssemblyLine/al_courts.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<a id="AssemblyLine.al_courts.ALCourtLoader.unique_column_values"></a>

Expand Down Expand Up @@ -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&#x27;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&#x27;s full details later using the as_court() method) and
the second element is the display value from the specified display_column.

**Arguments**:

Expand All @@ -313,7 +314,7 @@ useful for retrieving the court&#x27;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&#x27;s name or other display column value.

<a id="AssemblyLine.al_courts.ALCourtLoader.filter_courts"></a>

Expand All @@ -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 &quot;index&quot; refers to the dataframe index and &quot;name&quot;
Each tuple has the format (index, display_value), where &quot;index&quot; refers to the dataframe index and &quot;display_value&quot;
is determined by the `display_column`.

**Arguments**:
Expand All @@ -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&#x27;s name or other display column value.

<a id="AssemblyLine.al_courts.ALCourtLoader.as_court"></a>

Expand Down
28 changes: 0 additions & 28 deletions docs/components/AssemblyLine/al_general.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -1430,33 +1429,6 @@ Avoid using, this is created for 209A.

- `str` - A string of unique letters.

<a id="AssemblyLine.al_general.fa_icon"></a>

#### 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 &#x27;blue&#x27; or
&#x27;`DDDDDD`&#x27;. Defaults to Bootstrap theme color &quot;primary&quot;.

**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 &quot;primary&quot;.
- `color_css` _Optional[str]_ - A CSS variable or color reference. Defaults to None.
- `size` _str_ - The size of the icon. Defaults to &quot;sm&quot;.


**Returns**:

- `str` - HTML for the icon.

<a id="AssemblyLine.al_general.is_sms_enabled"></a>

#### is\_sms\_enabled()
Expand Down
2 changes: 1 addition & 1 deletion docs/components/AssemblyLine/translation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down