Skip to content

Improve condition test helper docstrings#169871

Merged
emontnemery merged 3 commits intodevfrom
condition_test_helpers_improve_docstrings
May 5, 2026
Merged

Improve condition test helper docstrings#169871
emontnemery merged 3 commits intodevfrom
condition_test_helpers_improve_docstrings

Conversation

@emontnemery
Copy link
Copy Markdown
Contributor

Proposed change

Improve condition test helper docstrings

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:
  • Link to developer documentation pull request:
  • Link to frontend pull request:

Checklist

  • I understand the code I am submitting and can explain how it works.
  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.
  • Any generated code has been carefully reviewed for correctness and compliance with project standards.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies a diff between library versions and ideally a link to the changelog/release notes is added to the PR description.

To help with the load of incoming pull requests:

Copilot AI review requested due to automatic review settings May 5, 2026 20:00
@home-assistant home-assistant Bot added cla-signed code-quality small-pr PRs with less than 30 lines. labels May 5, 2026
@emontnemery emontnemery added this to the 2026.5.0 milestone May 5, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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_all to 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.

Comment thread tests/components/common.py Outdated
Comment thread tests/components/common.py Outdated
Comment thread tests/components/common.py Outdated
Copilot AI review requested due to automatic review settings May 5, 2026 22:10
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.

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.
@emontnemery emontnemery merged commit 65f9dcd into dev May 5, 2026
47 of 48 checks passed
@emontnemery emontnemery deleted the condition_test_helpers_improve_docstrings branch May 5, 2026 22:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla-signed code-quality small-pr PRs with less than 30 lines.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants