-
Notifications
You must be signed in to change notification settings - Fork 7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add To-do due date/time and description service calls #29900
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
✅ Approved. Can be merged as soon as the parent PR gets merged.
source/_integrations/todo.markdown
Outdated
@@ -61,6 +61,11 @@ Add a new To-do Item. A To-do list `target` is selected with a [Target Selector] | |||
| Service data attribute | Optional | Description | Example | | |||
| ---------------------- | -------- | ----------- | --------| | |||
| `item` | no | the name of the to-do Item. | Submit income tax return | |||
| `due_date` | yes | The date the to-do item is expected to be completed. | 2024-04-10 | |||
| `due_date_time` | yes | The date and time the to-do item is expected to be completed. | 2024-04-10 23:00:00 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm, now that I read this I'm thinking it should be due_datetime
instead. Is there a reason to write it date_time
instead of datetime
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Or just due
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, but that's more than a name change.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The rationale for the current name is only to match the convention of https://www.home-assistant.io/integrations/google/#service-googlecreate_event -- I don't have a preference.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To elaborate -- i totally know what you are talking about here, and was thinking about this when adding it.
"due_datetime" would be the way to name this to make it like a python name.
"due_date" and "due_date_time" seemed to be reasonable from a user perspective so i went with that name given it was that style in calendar.
(What i'd really love is "due" with a combined date or date time selector)
Happy to adjust if there are already conventions or preferences.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmz I see your point, just due
(combined) won't work because of selectors, so that makes total sense.
I'm personally in the middle if it boils down to date_time
vs datetime
, although from a consistency perspective:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
for context: there are currently 11 files in the docs that use date_time
, and 107 that mention datetime
(over 400 occurrences).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We decided to go ahead with the rename. The google calendar parameter should probably be renamed too at some point, but that'll be a breaking change.
following review comment by frenck.
I've opened home-assistant/core#104698 to rename the parameter to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The rename of due_date_time
to due_datetime
for the todo integration is complete. This can be merged. Thanks!
Proposed change
Add To-do due date/time and description service call documentation.
Type of change
current
branch).current
branch).next
branch).next
branch).Additional information
Checklist
current
branch.next
branch.