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 description of the script toggle action #134093

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from

Conversation

NoRi2909
Copy link
Contributor

Proposed change

The 'Script: Toggle' action repeats that as "Toggle a script. …" in its description. This should be "Toggles …" to be consistent with the descriptions of the other Script actions that use "Runs …" and "Stops …"

But actually the other two also don't repeat "Turn on" or "Turn off" either, but explain the actual result, too.

Thus we can simply drop that part and reword the rest. This also fixes the wrong comma before "if".

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:

The 'Script: Toggle' action repeats that as "Toggle a script. …" in its description. This should be "Toggles …" to be consistent with the descriptions of the other Script actions.

But actually the other two also don't repeat "Turn on" or "Turn off" either but explain the actual result, too.

Thus we can simply drop that part and reword the rest. This also fixes the wrong comma before "if".
@NoRi2909 NoRi2909 requested a review from a team as a code owner December 27, 2024 15:39
@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 (script) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of script 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 script 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.

@home-assistant home-assistant bot marked this pull request as draft December 29, 2024 12:30
@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.

@NoRi2909 NoRi2909 requested a review from davet2001 December 29, 2024 12:35
@NoRi2909 NoRi2909 marked this pull request as ready for review December 29, 2024 12:36
Copy link
Contributor

@davet2001 davet2001 left a comment

Choose a reason for hiding this comment

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

Looks good to me! Thanks @NoRi2909

@davet2001 davet2001 changed the title Update description of the Toggle action Update description of the script toggle action Dec 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Small grammar fix for inconsistent 'Script: Toggle' action description
2 participants