To-do list: add note that item can be UID #38704

c0ffeeca7 · 2025-04-24T08:12:49Z

Proposed change

To-do list integration: add note that item can be UID

add example response to get_items action, to illustrate better what is meant by UID and how I can see it (It doesn't show in the UI, only in YAML)

Type of change

Spelling, grammar or other readability improvements (current branch).
Adjusted missing or incorrect information in the current documentation (current branch).
Added documentation for a new integration I'm adding to Home Assistant (next branch).
- I've opened up a PR to add logos and icons in Brands repository.
Added documentation for a new feature I'm adding to Home Assistant (next branch).
Removed stale or deprecated documentation.

Additional information

Link to parent pull request in the codebase:
Link to parent pull request in the Brands repository:
This PR fixes or closes issue: fixes #

Checklist

This PR uses the correct branch, based on one of the following:
- I made a change to the existing documentation and used the current branch.
- I made a change that is related to an upcoming version of Home Assistant and used the next branch.
The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

Documentation
- Clarified that the item field in to-do actions can accept either the name/summary or UID, recommending UID for safety.
- Updated example tables and descriptions for to-do actions accordingly.
- Revised examples to use a different to-do list entity and added a sample response for the to-do list retrieval action.

netlify · 2025-04-24T08:13:18Z

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	`8574b64`
🔍 Latest deploy log	https://app.netlify.com/sites/home-assistant-docs/deploys/680a247528cd3c0008028750
😎 Deploy Preview	https://deploy-preview-38704--home-assistant-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

coderabbitai · 2025-04-24T08:14:31Z

📝 Walkthrough

Walkthrough

The documentation for the todo integration was updated to clarify the usage of the item field in several actions, specifying that it can accept either the name/summary or the UID of a to-do item. Instructions were added on how to obtain the UID using the get_items action. Example tables and descriptions were revised to reflect these clarifications, and a new sample response was provided for the get_items action. No changes were made to code or public entity declarations.

Changes

File(s)	Change Summary
source/_integrations/todo.markdown	Updated documentation to clarify `item` field usage, revised example tables, and added a sample response.

Sequence Diagram(s)

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ae3d9db and 8574b64.

📒 Files selected for processing (1)

source/_integrations/todo.markdown (3 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

source/_integrations/todo.markdown

⏰ Context from checks skipped due to timeout of 90000ms (3)

GitHub Check: Redirect rules - home-assistant-docs
GitHub Check: Header rules - home-assistant-docs
GitHub Check: Pages changed - home-assistant-docs

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.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

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)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (3)

source/_integrations/todo.markdown (3)

79-90: Clarify that UIDs are not shown in the UI.
Consider adding a brief note around this response example to explain that the uid field is only visible via the API (e.g., todo.get_items) and does not appear in the Home Assistant frontend. This will help users understand why they won’t see UIDs in the UI.

96-101: Refine the item field description for brevity.
The new description correctly states that item accepts a name/summary or UID. For a cleaner, more active tone, you might rephrase to:
“To find an item’s UID, use the todo.get_items action.”

121-128: Ensure selector link styling is consistent.
The UID guidance in the todo.update_item table is on point. Please double-check that the “[Target Selector]” link styling here matches the lowercase “[target selector]” used in other action descriptions to maintain uniformity across the docs.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fdbcd5f and 6c0d789.

📒 Files selected for processing (1)

source/_integrations/todo.markdown (3 hunks)

🔇 Additional comments (2)

source/_integrations/todo.markdown (2)

73-73: Updated example entity_id aligns with PR summary.
The todo.get_items example now uses todo.vacation_preparation instead of todo.personal_tasks, matching the PR's intent. Please verify that this entity is referenced elsewhere or update related sections for consistency.

146-148: UID guidance correctly applied.
The todo.remove_item table entry now mirrors the UID instruction from other actions, ensuring consistency in how users locate and reference items.

TimoPtr · 2025-04-24T11:39:54Z

source/_integrations/todo.markdown

-| `description`  | yes      | A more complete description than the one provided by the summary. | Collect all necessary documents and submit the final return. |
+| Data attribute | Optional | Description                                                                                                            | Example                                                              |
+| -------------- | -------- | ---------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- |
+| `item`         | no       | The name/summary or UID of the to-do item. To find the UID of an item, perform a `get_items` action on the to-do list. | `Submit income tax return` or `01244b28-e604-11ee-a0a4-e45f0197c057` |


Maybe be more specific like I did here home-assistant/core#143556 saying that UID is better to avoid issues. But name can still be use.

I do not know about that, using name is very user friendly and pretty safe as long as you do not have duplicates.
But I am fine with this version regardless

The devil is in the detail here. I'm suggesting that we should encourage to use the UID but name are fine. So if the issue occur people will have read somewhere that they could use UID instead.

For sure it's not UI friendly at all

Then if the devil is in the details, I would say that uuid can be used to dedupe times with the same name in case it's needed ☺️

c0ffeeca7 · 2025-04-24T12:54:24Z

Thank you, @jlpouffier and @TimoPtr 👍

To-do list: add note that item can be UID

52f00e2

c0ffeeca7 requested a review from a team as a code owner April 24, 2025 08:12

home-assistant bot added the current This PR goes into the current branch label Apr 24, 2025

Tweak

6c0d789

coderabbitai bot reviewed Apr 24, 2025

View reviewed changes

Revert UID comment in add action

ae3d9db

TimoPtr mentioned this pull request Apr 24, 2025

Encourage to use UID instead of name for update and delete todos home-assistant/core#143556

Merged

19 tasks

home-assistant bot added the has-parent This PR has a parent PR in a other repo label Apr 24, 2025

TimoPtr reviewed Apr 24, 2025

View reviewed changes

Implement review comment

8574b64

TimoPtr approved these changes Apr 24, 2025

View reviewed changes

c0ffeeca7 merged commit 54a999d into current Apr 24, 2025
9 checks passed

c0ffeeca7 deleted the todo-item-can-be-uid branch April 24, 2025 12:54

github-actions bot locked and limited conversation to collaborators Apr 26, 2025

home-assistant bot added the parent-merged The parent PR has been merged already label Apr 30, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

To-do list: add note that item can be UID #38704

To-do list: add note that item can be UID #38704

c0ffeeca7 commented Apr 24, 2025 •

edited by coderabbitai bot

Loading

netlify bot commented Apr 24, 2025 •

edited

Loading

coderabbitai bot commented Apr 24, 2025 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s)

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

TimoPtr Apr 24, 2025

c0ffeeca7 Apr 24, 2025

jlpouffier Apr 24, 2025

TimoPtr Apr 24, 2025

jlpouffier Apr 24, 2025

c0ffeeca7 commented Apr 24, 2025

To-do list: add note that item can be UID #38704

To-do list: add note that item can be UID #38704

Conversation

c0ffeeca7 commented Apr 24, 2025 • edited by coderabbitai bot Loading

Proposed change

Type of change

Additional information

Checklist

Summary by CodeRabbit

netlify bot commented Apr 24, 2025 • edited Loading

✅ Deploy Preview for home-assistant-docs ready!

coderabbitai bot commented Apr 24, 2025 • edited Loading

Walkthrough

Changes

Sequence Diagram(s)

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

TimoPtr Apr 24, 2025

Choose a reason for hiding this comment

c0ffeeca7 Apr 24, 2025

Choose a reason for hiding this comment

jlpouffier Apr 24, 2025

Choose a reason for hiding this comment

TimoPtr Apr 24, 2025

Choose a reason for hiding this comment

jlpouffier Apr 24, 2025

Choose a reason for hiding this comment

c0ffeeca7 commented Apr 24, 2025

c0ffeeca7 commented Apr 24, 2025 •

edited by coderabbitai bot

Loading

netlify bot commented Apr 24, 2025 •

edited

Loading

coderabbitai bot commented Apr 24, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)