Skip to content
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.

Sign up for GitHub

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 "summary" besides "name" to clarify description #37511

Merged
merged 7 commits into from
Feb 17, 2025
Merged

Add "summary" besides "name" to clarify description #37511

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
432975c
Add "summary" besides "name" to clarify description
NoRi2909 Feb 17, 2025
6194e41
Change inconsistent occurrence of "Item" to lower-case
NoRi2909 Feb 17, 2025
6d117f2
Fix one capitalized "To-do"
NoRi2909 Feb 17, 2025
6aa2a59
Add missing period in first table
NoRi2909 Feb 17, 2025
4cec553
Replace "and" with a "slash" (1)
NoRi2909 Feb 17, 2025
4d9a8be
Replace "and" with a "slash" (2)
NoRi2909 Feb 17, 2025
d6f9560
Remove excessive space char
NoRi2909 Feb 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions source/_integrations/todo.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,12 +80,12 @@ data:

Add a new to-do item. A to-do list `target` is selected with a [Target Selector](/docs/blueprint/selectors/#target-selector) and the `data` payload supports the following fields:

| 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_datetime` | yes | The date and time the to-do item is expected to be completed. | 2024-04-10 23:00:00 |
| `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 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_datetime` | yes | The date and time the to-do item is expected to be completed. | 2024-04-10 23:00:00 |
| `description` | yes | A more complete description than the one provided by the summary. | Collect all necessary documents and submit the final return. |

Only one of `due_date` or `due_datetime` may be specified.

Expand All @@ -107,9 +107,9 @@ Update a to-do item. A to-do list `target` is selected with a [Target Selector](

| Data attribute | Optional | Description | Example |
| -------------- | -------- | ----------------------------------------------------------------- | ------------------------------------------------------------ |
| `item` | no | The name of the to-do Item to update. | Submit income tax return |
| `rename` | yes | The new name of the to-do Item. | Something else |
| `status` | yes | The overall status of the To-do Item. | `needs_action` or `completed` |
| `item` | no | The name/summary of the to-do item to update. | Submit income tax return |
| `rename` | yes | The new name of the to-do item. | Something else |
| `status` | yes | The overall status of the to-do item. | `needs_action` or `completed` |
| `due_date` | yes | The date the to-do item is expected to be completed. | 2024-04-10 |
| `due_datetime` | yes | The date and time the to-do item is expected to be completed. | 2024-04-10 23:00:00 |
| `description` | yes | A more complete description than the one provided by the summary. | Collect all necessary documents and submit the final return. |
Expand Down