document actions that trigger a 'shopping_list_updated ' event #37415
Conversation
…' event - list actions as defined in https://github.com/home-assistant/core/blob/35416189f2944f58b5b91d9cf8ac90a491a10890/homeassistant/components/shopping_list/__init__.py#L301 - inspired by #37405
home-assistant
bot
added
current
|
It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the |
home-assistant
bot
added
the
needs-rebase
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
c0ffeeca7
removed
in-progress
home-assistant
bot
added
in-progress
|
It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the |
📝 WalkthroughWalkthroughThe changes update the shopping list documentation by introducing four new action triggers— Changes
Sequence Diagram(s)sequenceDiagram
participant U as User
participant SL as Shopping List Integration
participant AS as Automation System
U->>SL: Perform action (clear, sorted, reorder, update_list)
SL->>AS: Emit "shopping_list_updated" event with specific action
AS->>U: Process event (trigger automation response)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
source/_integrations/shopping_list.markdown (2)
111-118: Improve formatting and enhance action descriptions.The new section effectively documents the additional trigger actions, but could benefit from some improvements:
- Fix formatting:
-You can also trigger an automation when a `shopping_list_updated` event was triggered by any of the following actions: - -- `clear`: A completed item was cleared from the list. -- `sorted`: The items in the list were sorted by name. -- `reorder` An item has been reordered in the list. -- `update_list` All items have been updated. - -In these cases, the event does not return a list item. +You can also trigger an automation when a `shopping_list_updated` event was triggered by any of the following actions: + +* `clear`: A completed item was cleared from the list +* `sorted`: The items in the list were sorted by name +* `reorder`: An item has been reordered in the list +* `update_list`: All items have been updated + +In these cases, the event does not return a list item. +
- Consider adding an example automation snippet for one of these new actions to demonstrate usage.
Would you like me to generate an example automation snippet for one of these new actions?
🧰 Tools
🪛 LanguageTool
[uncategorized] ~113-~113: Loose punctuation mark.
Context: ...any of the following actions: -clear: A completed item was cleared from the l...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~114-~114: Loose punctuation mark.
Context: ...em was cleared from the list. -sorted: The items in the list were sorted by na...(UNLIKELY_OPENING_PUNCTUATION)
🪛 markdownlint-cli2 (0.17.2)
118-118: Files should end with a single newline character
null(MD047, single-trailing-newline)
118-118: Add newline at end of file.Add a newline character at the end of the file to comply with standard text file requirements.
In these cases, the event does not return a list item. +🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
118-118: Files should end with a single newline character
null(MD047, single-trailing-newline)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/shopping_list.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/shopping_list.markdown
[uncategorized] ~113-~113: Loose punctuation mark.
Context: ...any of the following actions: - clear: A completed item was cleared from the l...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~114-~114: Loose punctuation mark.
Context: ...em was cleared from the list. - sorted: The items in the list were sorted by na...
(UNLIKELY_OPENING_PUNCTUATION)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/shopping_list.markdown
118-118: Files should end with a single newline character
null
(MD047, single-trailing-newline)
Proposed change
document actions that trigger a 'shopping_list_updated ' event
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
New Features
Documentation