Improve condition test helper docstrings#169871
Merged
emontnemery merged 3 commits intodevfrom May 5, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates docstrings in tests/components/common.py to better describe how the condition test parametrization helpers build state sequences and expected evaluations.
Changes:
- Expanded docstrings for
parametrize_condition_states_any/parametrize_condition_states_allto document returned tuple structure and argument semantics. - Expanded docstrings for numerical condition helper parametrizers to explain generated threshold variants (“above”, “below”, “between”) and how units/device-class filtering are applied.
MartinHjelmare
approved these changes
May 5, 2026
Comment on lines
+1805
to
+1806
| generates target/other/excluded states by varying this | ||
| attribute. |
Comment on lines
+1927
to
+1928
| generates target/other/excluded states by varying this | ||
| attribute. |
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
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.
Proposed change
Improve condition test helper docstrings
Type of change
Additional information
Checklist
ruff format homeassistant tests)If user exposed functionality or configuration variables are added/changed:
If the code communicates with devices, web services, or third-party tools:
Updated and included derived files by running:
python3 -m script.hassfest.requirements_all.txt.Updated by running
python3 -m script.gen_requirements_all.To help with the load of incoming pull requests: