From 70723aa214b28da57a0aa05d354859c3f78982ce Mon Sep 17 00:00:00 2001 From: Norbert Rittel Date: Mon, 17 Feb 2025 13:53:19 +0100 Subject: [PATCH] Add "summary" besides "name" to clarify description (#37511) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: AbĂ­lio Costa --- source/_integrations/todo.markdown | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/source/_integrations/todo.markdown b/source/_integrations/todo.markdown index 8ae22ec8a29..445dbc8c54e 100644 --- a/source/_integrations/todo.markdown +++ b/source/_integrations/todo.markdown @@ -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. @@ -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. |