display_order for to-do list card
#36989
Conversation
home-assistant
bot
added
has-parent
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe pull request introduces a new configuration option Changes
Sequence DiagramsequenceDiagram
participant User
participant Configuration
participant TodoList
User->>Configuration: Specify display_order
Configuration->>TodoList: Apply sorting method
alt No sorting specified
TodoList-->>User: Display items in original order
else Alphabetical Ascending
TodoList-->>User: Sort items A-Z
else Alphabetical Descending
TodoList-->>User: Sort items Z-A
else Due Date Ascending
TodoList-->>User: Sort by earliest due date first
else Due Date Descending
TodoList-->>User: Sort by latest due date first
end
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/_dashboards/todo-list.markdown (2)
74-78: Improve the documentation structure and add examples.While the documentation is technically accurate, consider these improvements for better clarity:
- Structure the description as a list for better readability:
- description: "Optionally sorts the items in the to-do list for display. Options are: `none`: Show the list in its original order. `alpha_asc`: Sort the list in alphabetical order. `alpha_desc`: Sort the list in reverse alphabetical order. `duedate_asc`: Sort the list by due date (soonest first). `duedate_desc`: Sort the list by reverse due date (soonest last)." + description: "Optionally sorts the items in the to-do list for display. Available options:\n + - `none`: Show the list in its original order\n + - `alpha_asc`: Sort the list in alphabetical order\n + - `alpha_desc`: Sort the list in reverse alphabetical order\n + - `duedate_asc`: Sort the list by due date (soonest first)\n + - `duedate_desc`: Sort the list by reverse due date (soonest last)"
- Add information about validation behavior for invalid values
- Add an example showing the usage:
# Example with display order type: todo-list entity: todo.shopping_list title: Shopping List display_order: alpha_asc
73-78: Add display_order to the Examples section.To help users understand how to use this new feature, consider adding an example that demonstrates the
display_orderconfiguration in the Examples section at the end of the file. This would complement the existing title example.# Example with display order and other options type: todo-list entity: todo.shopping_list title: Sorted Shopping List display_order: alpha_asc hide_completed: true
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_dashboards/todo-list.markdown(1 hunks)
⏰ 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
🔇 Additional comments (1)
source/_dashboards/todo-list.markdown (1)
73-78: Documentation successfully captures the new feature.The documentation for the
display_orderoption is well-integrated into the existing configuration section and provides clear information about the available sorting options. This aligns well with the PR objectives of documenting this new feature.
home-assistant
bot
removed
the
parent-merged
Proposed change
Document display_order option for todo card.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
display_orderfor to-do list cards