Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update climate strings for consistent names and descriptions #130967

Merged
merged 5 commits into from
Nov 25, 2024

Conversation

NoRi2909
Copy link
Contributor

Fix the current naming and description of the set_temperature action and its different data attributes.

Currently the names are inconsistent with the defined attributes of a climate device and the descriptions don't add any information as they just repeat the names in a different word order.

In addition it adds "operation" to the preset mode explanations to make them consistent with all other mode actions.

Proposed change

Bring the descriptions of the set_temperature action and its data attributes to the usual level.
Better align them with the online documentation.
Remove several inconsistencies.

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

Checklist

  • 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.

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 link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

Fix the current naming and description of the `set_temperature` action and its different data attributes.

Currently the names are inconsistent with the defined attributes of a climate device and the decriptions don't add any information as they just repeat the names in a different word order.
@home-assistant
Copy link

Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (climate) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of climate can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign climate Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

@epenet epenet changed the title Update strings.json for consistent names and descriptions Update climate strings for consistent names and descriptions Nov 19, 2024
homeassistant/components/climate/strings.json Outdated Show resolved Hide resolved
homeassistant/components/climate/strings.json Outdated Show resolved Hide resolved
@home-assistant
Copy link

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@home-assistant home-assistant bot marked this pull request as draft November 21, 2024 20:29
@NoRi2909 NoRi2909 marked this pull request as ready for review November 22, 2024 11:07
@home-assistant home-assistant bot requested a review from frenck November 22, 2024 11:08
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Not all requested changes have been processed. Resetting the review status back to: Requested changes.

@home-assistant home-assistant bot marked this pull request as draft November 22, 2024 11:29
@NoRi2909 NoRi2909 marked this pull request as ready for review November 22, 2024 11:56
@home-assistant home-assistant bot requested a review from frenck November 22, 2024 11:56
@home-assistant home-assistant bot marked this pull request as draft November 22, 2024 12:02
@NoRi2909 NoRi2909 marked this pull request as ready for review November 22, 2024 12:20
@home-assistant home-assistant bot requested a review from frenck November 22, 2024 12:20
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Thanks, @NoRi2909 👍

../Frenck

@frenck frenck merged commit 4e22da2 into home-assistant:dev Nov 25, 2024
64 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Nov 26, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Climate: Improve descriptions of target temperatures in set_temperature action
2 participants