From 8b85efd9370e2df576c120d956dee9e6c453fd1b Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Thu, 9 Nov 2023 17:58:19 +0100 Subject: [PATCH 1/3] Correct spelling of to-do list --- source/_integrations/todo.markdown | 36 +++++++++++++++--------------- 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/source/_integrations/todo.markdown b/source/_integrations/todo.markdown index 643cad441140..334b3021dc4f 100644 --- a/source/_integrations/todo.markdown +++ b/source/_integrations/todo.markdown @@ -1,6 +1,6 @@ --- -title: To-do -description: Instructions on how to use To-do Lists within Home Assistant. +title: To-do list +description: Instructions on how to use to-do lists within Home Assistant. ha_domain: todo ha_release: 2023.11 ha_category: @@ -11,32 +11,32 @@ ha_codeowners: ha_integration_type: entity --- -The To-do List integration provides todo list entities, allowing other integrations -to integrate To-do Lists into Home Assistant. To-do lists are shown on the To-do list +The to-do list integration provides to-do list entities, allowing other integrations +to integrate to-do lists into Home Assistant. To-do lists are shown on the to-do list dashboard for tracking items and whether or not they have been completed. {% include integrations/building_block_integration.md %} -## Viewing and managing To-do lists +## Viewing and managing to-do lists -Each To-do list is represented as its own entity in Home Assistant and can be +Each to-do list is represented as its own entity in Home Assistant and can be viewed and managed on a to-do list dashboard. You can find the to-do list dashboard in the main sidebar of your Home Assistant instance. -## The state of a To-do List entity +## The state of a to-do list entity -The state of a To-do List entity is a number, which represents the number of +The state of a to-do list entity is a number, which represents the number of incomplete items in the list. ## Services -Some To-do List integrations allow Home Assistant to manage the To-do Items in the list. The -services provided by some To-do List entities are described below or you can read more about [Service Calls](/docs/scripts/service-calls/). +Some to-do list integrations allow Home Assistant to manage the to-do items in the list. The +services provided by some to-do list entities are described below or you can read more about [Service Calls](/docs/scripts/service-calls/). ### Service `todo.add_item` -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: +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: | Service data attribute | Optional | Description | Example | | ---------------------- | -------- | ----------- | --------| @@ -49,21 +49,21 @@ service: todo.add_item target: entity_id: todo.personal_tasks data: - item: "Submit Income Tax Return" + item: "Submit income tax return" ``` ### Service `todo.update_item` -Update a 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: +Update a 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: | Service 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 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` At least one of `rename` or `status` is required. This is a full example of -a service call that updates the status and the name of a to-do Item. +a service call that updates the status and the name of a to-do item. ```yaml service: todo.update_item @@ -77,7 +77,7 @@ data: ### Service `todo.remove_item` -Removing a 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: +Removing a 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: | Service data attribute | Optional | Description | Example | | ---------------------- | -------- | ----------- | --------| From f858761741d80df3c8b68b1c0d1d88fb4d068cef Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Fri, 10 Nov 2023 09:07:49 +0100 Subject: [PATCH 2/3] Update source/_integrations/todo.markdown Co-authored-by: Martin Hjelmare --- source/_integrations/todo.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/todo.markdown b/source/_integrations/todo.markdown index 334b3021dc4f..11f112cb206c 100644 --- a/source/_integrations/todo.markdown +++ b/source/_integrations/todo.markdown @@ -36,7 +36,7 @@ services provided by some to-do list entities are described below or you can rea ### Service `todo.add_item` -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: +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: | Service data attribute | Optional | Description | Example | | ---------------------- | -------- | ----------- | --------| From 3fab1458007825a30803b7798fdc623700af5c86 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Fri, 10 Nov 2023 09:07:54 +0100 Subject: [PATCH 3/3] Update source/_integrations/todo.markdown Co-authored-by: Martin Hjelmare --- source/_integrations/todo.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/todo.markdown b/source/_integrations/todo.markdown index 11f112cb206c..e970205be614 100644 --- a/source/_integrations/todo.markdown +++ b/source/_integrations/todo.markdown @@ -77,7 +77,7 @@ data: ### Service `todo.remove_item` -Removing a 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: +Removing a 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: | Service data attribute | Optional | Description | Example | | ---------------------- | -------- | ----------- | --------|