diff --git a/site/about/glossary/key_concepts/_outputs.qmd b/site/about/glossary/key_concepts/_outputs.qmd index 59fbe7506d..f1154081c8 100644 --- a/site/about/glossary/key_concepts/_outputs.qmd +++ b/site/about/glossary/key_concepts/_outputs.qmd @@ -3,4 +3,4 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> outputs -: Custom tests can return elements like tables or plots. Tables may be a list of dictionaries (each representing a row) or a [pandas DataFrame](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html). Plots may be [matplotlib](https://matplotlib.org/) or [plotly](https://plotly.com/) figures. \ No newline at end of file +: Custom tests can return elements like tables or plots. Tables may be a list of dictionaries (each representing a row), a [pandas DataFrame](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html), or a [pandas Styler](https://pandas.pydata.org/docs/reference/api/pandas.io.formats.style.Styler.html), whose cell styles (background color, text color, font weight, and text alignment) are preserved in the {{< var validmind.platform >}} and in exported documents. Plots may be [matplotlib](https://matplotlib.org/) or [plotly](https://plotly.com/) figures. \ No newline at end of file diff --git a/site/developer/how-to/testing-overview.qmd b/site/developer/how-to/testing-overview.qmd index 129c428de9..6814ab952c 100644 --- a/site/developer/how-to/testing-overview.qmd +++ b/site/developer/how-to/testing-overview.qmd @@ -104,7 +104,7 @@ listing: - Any setting that isn't a dataset or model[^1] **Outputs** -: Tests return results like tables and plots. Tables can be lists of dictionaries or pandas DataFrames; plots can be matplotlib or plotly figures. +: Tests return results like tables and plots. Tables can be lists of dictionaries, pandas DataFrames, or pandas Stylers;[^2] plots can be matplotlib or plotly figures. **Logging results** : Call `.log()` on a test result to send it to the {{< var validmind.platform >}}. @@ -235,3 +235,5 @@ Learn more about using the other features of the {{< var validmind.developer >}} [^1]: Use `vm.tests.describe_test("test_id")` for programmatic parameter details, or browse the [{{< var vm.product >}} test sandbox](test-sandbox.qmd). +[^2]: Cell styles applied with a [pandas `Styler`](https://pandas.pydata.org/docs/reference/api/pandas.io.formats.style.Styler.html) (background color, text color, font weight, and text alignment) are kept when the result is logged, and shown in the {{< var validmind.platform >}} and in HTML and DOCX exports of your documents. Requires {{< var validmind.developer >}} version **2.14** or later. +