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
Update Light flash description #98252
Conversation
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! |
Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration ( Code owner commandsCode owners of
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
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 :) |
There was a problem hiding this 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.
1def60f
to
26a3663
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @apbarratt 👍
Thanks guys, as promised, here is the follow up PR to update the website documentation :) |
light.turn_on
service description for theflash
option gave the impression of a boolean value being required when in fact a string of eithershort
orlong
was required. Updated this to match the documentation found at https://www.home-assistant.io/integrations/lightlight.turn_off
also described the existence of aflash
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
Additional information
Checklist
black --fast 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
..coveragerc
.To help with the load of incoming pull requests: