Update todo.md for completed field
#2683
Conversation
📝 WalkthroughWalkthroughThe documentation for the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant TodoItem (Entity Doc)
User->>TodoItem (Entity Doc): Reads property list
TodoItem (Entity Doc)-->>User: Returns properties including new 'completed' field
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/core/entity/todo.md (1)
117-117: Fix table formatting for the newcompletedrow.
The added row is missing the trailing pipe and has an extra space inside the<code>tag, which breaks the table styling.-| completed | <code> datetime.datetime | None</code> | `None` | A timestamp indicating the time this item was last marked `COMPLETE`. +| completed | <code>datetime.datetime | None</code> | `None` | A timestamp indicating the time this item was last marked `COMPLETE`. |🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
117-117: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe(MD055, table-pipe-style)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
docs/core/entity/todo.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/core/entity/todo.md
117-117: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
🔇 Additional comments (1)
docs/core/entity/todo.md (1)
1-118: Verify rendering of the updated field.
Please preview the documentation site to ensure the newcompletedfield displays correctly in the table and adheres to Home Assistant’s docs formatting guidelines.🧰 Tools
🪛 LanguageTool
[grammar] ~7-~7: It appears that a hyphen is missing in the noun “to-do” (= task) or did you mean the verb “to do”?
Context: ...A To-do list entity is derived from the [homeassistant.components.todo.TodoListEntity](https://github.com/hom...(TO_DO_HYPHEN)
[grammar] ~17-~17: It appears that a hyphen is missing in the noun “to-do” (= task) or did you mean the verb “to do”?
Context: ...----------------------------------- | | todo_items |list[TodoItem] | Non...(TO_DO_HYPHEN)
🪛 markdownlint-cli2 (0.17.2)
112-112: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe(MD055, table-pipe-style)
113-113: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe(MD055, table-pipe-style)
114-114: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe(MD055, table-pipe-style)
115-115: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe(MD055, table-pipe-style)
116-116: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe(MD055, table-pipe-style)
117-117: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe(MD055, table-pipe-style)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/core/entity/todo.md (1)
117-117: Add missing trailing pipe in the new table row
The addedcompletedrow is missing the closing|, causing an inconsistency with the table‐pipe style (MD055). Please append a|at the end of the row to match the existing format.Verify documentation rendering
Since doc changes haven’t been previewed yet, please build or preview the site to ensure the new field displays correctly.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
117-117: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe(MD055, table-pipe-style)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
docs/core/entity/todo.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/core/entity/todo.md
117-117: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
(MD055, table-pipe-style)
Proposed change
For home-assistant/core#145820
Type of change
Checklist
Additional information
Summary by CodeRabbit