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 Light flash description #98252

Conversation

apbarratt
Copy link
Contributor

light.turn_on service description for the flash option gave the impression of a boolean value being required when in fact a string of either short or long was required. Updated this to match the documentation found at https://www.home-assistant.io/integrations/light

light.turn_off also described the existence of a flash option when none exists. I've removed this, which matches the aforementioned documentation too.

Proposed change

Just a quicky update to the descriptions of light.turn_on service to clarify the flash option and remove it completely from the turn_off service, where it does not seem to exist. I've made this match up with the descriptions given at https://www.home-assistant.io/integrations/light

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
    • Documentation string fix

Additional information

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

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 Black (black --fast 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.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

@home-assistant
Copy link

Hi @apbarratt

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

@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 (light) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of light 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 light Removes the current integration label and assignees on the pull request, add the integration domain after the command.

@home-assistant home-assistant bot marked this pull request as draft August 11, 2023 13:32
@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.

@apbarratt
Copy link
Contributor Author

Right, I've confirmed that turn_off does indeed have a flash option and I've committed a change to reflect that here now.

I'll try and submit another PR to add that into the website docs where it isn't listed. It hadn't worked for me and when I checked the website I took that as confirmation that this was a mistake. Sorry about that!

But I do still think updating the description text for those using yaml and reading the documentation table shown on the Developer Tools -> Services screen is important and brings it in line with what is shown on the website documentation :)

Copy link
Contributor

@c0ffeeca7 c0ffeeca7 left a comment

Choose a reason for hiding this comment

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

LGTM. Thank you, @apbarratt 👍

`light.turn_on` service description for the `flash` option gave the impression of a boolean value being required when in fact a string of either `short` or `long` was required.  Updated this to match the documentation found at https://www.home-assistant.io/integrations/light

`light.turn_off` also described the existence of a `flash` option when none exists.  I've removed this, which matches the aforementioned documentation too.
As discussed in feedback, turn-off does indeed seem to support flash.
@apbarratt apbarratt force-pushed the apbarratt-light-flash-description-update branch from 1def60f to 26a3663 Compare August 15, 2023 19:01
@apbarratt apbarratt marked this pull request as ready for review August 15, 2023 19:03
Copy link
Member

@gjohansson-ST gjohansson-ST left a comment

Choose a reason for hiding this comment

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

Thanks @apbarratt 👍

@gjohansson-ST gjohansson-ST merged commit 6c57395 into home-assistant:dev Aug 16, 2023
34 checks passed
@apbarratt
Copy link
Contributor Author

Thanks guys, as promised, here is the follow up PR to update the website documentation :)
home-assistant/home-assistant.io#28602

@github-actions github-actions bot locked and limited conversation to collaborators Aug 17, 2023
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.

None yet

3 participants