Update light.md to mention toggle support#2986
Open
ams2990 wants to merge 2 commits intohome-assistant:masterfrom
Open
Update light.md to mention toggle support#2986ams2990 wants to merge 2 commits intohome-assistant:masterfrom
ams2990 wants to merge 2 commits intohome-assistant:masterfrom
Conversation
Also fix a missing block quote close.
Author
Contributor
📝 WalkthroughWalkthroughDocumentation update to the light entity file adds a new example demonstrating how to toggle light devices using an async_toggle method. The change includes a closing code fence correction and a tip for no-sync toggle behavior. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/core/entity/light.md`:
- Around line 174-187: The doc incorrectly states sync toggle isn't supported;
update the Toggle Light Device section for LightEntity to reflect that toggle()
is available (inherited from ToggleEntity) and show both sync and async variants
(toggle and async_toggle) or explicitly state toggle is inherited and recommend
implementing turn_on/turn_off instead; reference LightEntity, ToggleEntity,
toggle(), async_toggle(), turn_on, and turn_off so readers can find the
implementation points.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 43776e2b-e9a5-4be3-ac2f-9615a0394669
📒 Files selected for processing (1)
docs/core/entity/light.md
Merged
21 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Also fix a missing block quote close.
Proposed change
Update light documentation to match home-assistant/core#156196.
Type of change
Checklist
Additional information
Summary by CodeRabbit