Repository navigation
[SC-18631] Document styled test summary tables (pandas Styler) - #1533
Merged
Merged
Conversation
Tests can return a pandas Styler; background color, text color, font weight and text alignment on cells are preserved in the platform and in HTML and DOCX exports (sc-15877). Updates the testing overview and the outputs glossary entry. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Contributor
Validate docs site✓ INFO: A live preview of the docs site is available — Open the preview |
cachafla
approved these changes
Oct 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What and why?
Part of the Docs 26.10 tracker (sc-18631), for sc-15877 (library #497, frontend #2470, backend #3040). Test authors can now return a pandas
Stylerfrom a test. Background color, text color, font weight and text alignment on cells are kept when the result is logged and rendered in the platform's documentation UI and in HTML and DOCX exports. Tables that embedded raw HTML the old way keep working.Changes:
developer/how-to/testing-overview.qmd: Outputs now lists pandas Stylers, with a footnote on which styles are preserved and where they show up, and the library version requirement.about/glossary/key_concepts/_outputs.qmd: same addition to the outputs glossary entry (used by the key concepts glossary and the FAQ).How to test
Preview (the preview site builds when the PR leaves draft; allow time for the deploy):
What needs special review?
validmind/__version__.pyon library main is 2.14.0 with the Styler change, but no 2.14 tag or PyPI release exists yet. Confirm the number against the release that ships with 26.10._convert_stylerallowlist (background/background-color, color, font-weight, text-align).Dependencies, breaking changes, and deployment notes
notebooks/how_to/tests/custom_tests/implement_custom_tests.ipynb. That notebook is refreshed from the library repo, so the example belongs there, and it should land only after the 2.14 library is published so the executed notebook does not fail on the current PyPI version.Release notes
Documented that tests can return pandas Styler tables with cell colors and emphasis preserved.
Checklist
🤖 Generated with Claude Code