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

Correct spelling of to-do list #29773

Merged
merged 3 commits into from
Nov 10, 2023
Merged

Correct spelling of to-do list #29773

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8b85efd
Correct spelling of to-do list
frenck Nov 9, 2023
f858761
Update source/_integrations/todo.markdown
frenck Nov 10, 2023
3fab145
Update source/_integrations/todo.markdown
frenck Nov 10, 2023
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
36 changes: 18 additions & 18 deletions source/_integrations/todo.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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 |
| ---------------------- | -------- | ----------- | --------|
Expand All @@ -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
Expand All @@ -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 |
| ---------------------- | -------- | ----------- | --------|
Expand Down