core: apply sentence-style capitalization to headings (#2188)

- to comply with MS Style Guide on [capitalization](https://learn.microsoft.com/en-us/style-guide/capitalization)
This commit is contained in:
c0ffeeca7 2024-05-23 10:10:20 +02:00 committed by GitHub
parent 8ce81001c3
commit 207c08678e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
23 changed files with 60 additions and 61 deletions

View File

@ -1,5 +1,5 @@
--- ---
title: Number Entity title: Number entity
sidebar_label: Number sidebar_label: Number
--- ---

View File

@ -1,5 +1,5 @@
--- ---
title: Remote Entity title: Remote entity
sidebar_label: Remote sidebar_label: Remote
--- ---
@ -25,7 +25,7 @@ Properties should always only return information from memory and not do I/O (lik
An activity is a predefined activity or macro that puts the remote in a specific state. For example, a "Watch TV" activity may turn on multiple devices and change the channel to a specific channel. An activity is a predefined activity or macro that puts the remote in a specific state. For example, a "Watch TV" activity may turn on multiple devices and change the channel to a specific channel.
## Supported Features ## Supported features
Supported features are defined by using values in the `RemoteEntityFeature` enum Supported features are defined by using values in the `RemoteEntityFeature` enum
and are combined using the bitwise or (`|`) operator. and are combined using the bitwise or (`|`) operator.
@ -38,7 +38,7 @@ and are combined using the bitwise or (`|`) operator.
## Methods ## Methods
### Turn On Command ### Turn on command
```python ```python
class MyRemote(RemoteEntity): class MyRemote(RemoteEntity):
@ -50,7 +50,7 @@ class MyRemote(RemoteEntity):
"""Send the power on command.""" """Send the power on command."""
``` ```
### Turn Off Command ### Turn off command
```python ```python
class MyRemote(RemoteEntity): class MyRemote(RemoteEntity):
@ -62,7 +62,7 @@ class MyRemote(RemoteEntity):
"""Send the power off command.""" """Send the power off command."""
``` ```
### Toggle Command ### Toggle command
```python ```python
class MyRemote(RemoteEntity): class MyRemote(RemoteEntity):
@ -74,7 +74,7 @@ class MyRemote(RemoteEntity):
"""Toggle a device.""" """Toggle a device."""
``` ```
### Send Command ### Send command
```python ```python
class MyRemote(RemoteEntity): class MyRemote(RemoteEntity):
@ -86,7 +86,7 @@ class MyRemote(RemoteEntity):
"""Send commands to a device.""" """Send commands to a device."""
``` ```
### Learn Command ### Learn command
Only implement this method if the flag `SUPPORT_LEARN_COMMAND` is set. Only implement this method if the flag `SUPPORT_LEARN_COMMAND` is set.
@ -100,7 +100,7 @@ class MyRemote(RemoteEntity):
"""Learn a command from a device.""" """Learn a command from a device."""
``` ```
### Delete Command ### Delete command
Only implement this method if the flag `SUPPORT_DELETE_COMMAND` is set. Only implement this method if the flag `SUPPORT_DELETE_COMMAND` is set.

View File

@ -1,5 +1,5 @@
--- ---
title: Scene Entity title: Scene entity
sidebar_label: Scene sidebar_label: Scene
--- ---

View File

@ -1,5 +1,5 @@
--- ---
title: Select Entity title: Select entity
sidebar_label: Select sidebar_label: Select
--- ---

View File

@ -1,5 +1,5 @@
--- ---
title: Sensor Entity title: Sensor entity
sidebar_label: Sensor sidebar_label: Sensor
--- ---

View File

@ -1,5 +1,5 @@
--- ---
title: Siren Entity title: Siren entity
sidebar_label: Siren sidebar_label: Siren
--- ---

View File

@ -1,11 +1,11 @@
--- ---
title: Speech To Text Entity title: Speech-to-text entity
sidebar_label: Speech To Text sidebar_label: Speech-to-text
--- ---
A speech to text (STT) entity allows other integrations or applications to stream speech data to the STT API and get text back. A speech-to-text (STT) entity allows other integrations or applications to stream speech data to the STT API and get text back.
A speech to text entity is derived from the [`homeassistant.components.stt.SpeechToTextEntity`](https://github.com/home-assistant/core/blob/dev/homeassistant/components/stt/__init__.py). A speech-to-text entity is derived from the [`homeassistant.components.stt.SpeechToTextEntity`](https://github.com/home-assistant/core/blob/dev/homeassistant/components/stt/__init__.py).
## Properties ## Properties

View File

@ -1,5 +1,5 @@
--- ---
title: Switch Entity title: Switch entity
sidebar_label: Switch sidebar_label: Switch
--- ---
@ -17,7 +17,7 @@ Properties should always only return information from memory and not do I/O (lik
| ---- | ---- | ------- | ----------- | ---- | ---- | ------- | -----------
| is_on | boolean | `None` | If the switch is currently on or off. | is_on | boolean | `None` | If the switch is currently on or off.
## Deprecated Properties ## Deprecated properties
The following properties are deprecated and should not be used by new integrations. Provide them as sensors instead. The following properties are deprecated and should not be used by new integrations. Provide them as sensors instead.
@ -28,7 +28,7 @@ Name | Type | Default | Description
## Methods ## Methods
### Turn On ### Turn on
Turn the switch on. Turn the switch on.
@ -43,7 +43,7 @@ class MySwitch(SwitchEntity):
"""Turn the entity on.""" """Turn the entity on."""
``` ```
### Turn Off ### Turn off
Turn the switch off. Turn the switch off.

View File

@ -1,5 +1,5 @@
--- ---
title: Text Entity title: Text entity
sidebar_label: Text sidebar_label: Text
--- ---

View File

@ -1,5 +1,5 @@
--- ---
title: Time Entity title: Time entity
sidebar_label: Time sidebar_label: Time
--- ---

View File

@ -1,6 +1,6 @@
--- ---
title: To-do List Entity title: To-do list entity
sidebar_label: To-do List sidebar_label: To-do list
--- ---
A To-do list entity is an entity that represents a To-do list. A To-do list contains A To-do list entity is an entity that represents a To-do list. A To-do list contains
@ -20,7 +20,7 @@ Properties should only return information from memory and not do I/O (like netwo
A `TodoListEntity` state is the count of incomplete items in the To-do list. A `TodoListEntity` state is the count of incomplete items in the To-do list.
## Supported Features ## Supported features
Supported features are defined by using values in the `TodoListEntityFeature` enum Supported features are defined by using values in the `TodoListEntityFeature` enum
and are combined using the bitwise or (`|`) operator. and are combined using the bitwise or (`|`) operator.
@ -37,10 +37,9 @@ and are combined using the bitwise or (`|`) operator.
## Methods ## Methods
### Create to-do items
### Create To-do items A to-do list entity may support creating to-do items by specifying the `CREATE_TODO_ITEM`
A To-do list entity may support creating To-do items by specifying the `CREATE_TODO_ITEM`
supported feature. supported feature.
```python ```python
@ -52,9 +51,9 @@ class MyTodoListEntity(TodoListEntity):
"""Add an item to the To-do list.""" """Add an item to the To-do list."""
``` ```
### Delete To-do items ### Delete to-do items
A To-do list entity may support deleting To-do items by specifying the `DELETE_TODO_ITEM` A To-do list entity may support deleting to-do items by specifying the `DELETE_TODO_ITEM`
supported feature. Integrations must support deleting multiple items. supported feature. Integrations must support deleting multiple items.
```python ```python
@ -66,9 +65,9 @@ class MyTodoListEntity(TodoListEntity):
"""Delete an item from the to-do list.""" """Delete an item from the to-do list."""
``` ```
### Update To-do items ### Update to-do items
A To-do list entity may support updating To-do items by specifying the `UPDATE_TODO_ITEM` A to-do list entity may support updating to-do items by specifying the `UPDATE_TODO_ITEM`
supported feature. The `TodoItem` field `uid` is always present and indicates supported feature. The `TodoItem` field `uid` is always present and indicates
which item should be updated. The item passed to update is a copy of the original which item should be updated. The item passed to update is a copy of the original
item with fields updated or cleared. item with fields updated or cleared.
@ -82,12 +81,12 @@ class MyTodoListEntity(TodoListEntity):
"""Add an item to the To-do list.""" """Add an item to the To-do list."""
``` ```
### Move To-do items ### Move to-do items
A To-do list entity may support re-ordering To-do items in the list by specifying A to-do list entity may support re-ordering to-do items in the list by specifying
the `MOVE_TODO_ITEM` supported feature. The To-do item with the specified `uid` the `MOVE_TODO_ITEM` supported feature. The to-do item with the specified `uid`
should be moved to the position in the list after the one specified by `previous_uid` (`None` means move to the first should be moved to the position in the list after the one specified by `previous_uid` (`None` means move to the first
position in the To-do list). position in the to-do list).
```python ```python
from homeassistant.components.todo import TodoListEntity from homeassistant.components.todo import TodoListEntity

View File

@ -1,6 +1,6 @@
--- ---
title: Text To Speech Entity title: Text-to-speech entity
sidebar_label: Text To Speech sidebar_label: Text-to-speech
--- ---
A text-to-speech (TTS) entity enables Home Assistant to speak to you. A text-to-speech (TTS) entity enables Home Assistant to speak to you.

View File

@ -1,5 +1,5 @@
--- ---
title: Update Entity title: Update entity
sidebar_label: Update sidebar_label: Update
--- ---
@ -33,7 +33,7 @@ Properties should always only return information from memory and not do I/O (lik
Other properties that are common to all entities such as `device_class`, `entity_category`, `icon`, `name` etc are still applicable. Other properties that are common to all entities such as `device_class`, `entity_category`, `icon`, `name` etc are still applicable.
## Supported Features ## Supported features
Supported features are defined by using values in the `UpdateEntityFeature` enum. Supported features are defined by using values in the `UpdateEntityFeature` enum.

View File

@ -1,5 +1,5 @@
--- ---
title: Vacuum Entity title: Vacuum entity
sidebar_label: Vacuum sidebar_label: Vacuum
--- ---
@ -35,7 +35,7 @@ Properties should always only return information from memory and not do I/O (lik
| `STATE_RETURNING` | The vacuum is done cleaning and is currently returning to the dock, but not yet docked. | `STATE_RETURNING` | The vacuum is done cleaning and is currently returning to the dock, but not yet docked.
| `STATE_ERROR` | The vacuum encountered an error while cleaning. | `STATE_ERROR` | The vacuum encountered an error while cleaning.
## Supported Features ## Supported features
Supported features are defined by using values in the `VacuumEntityFeature` enum Supported features are defined by using values in the `VacuumEntityFeature` enum
and are combined using the bitwise or (`|`) operator. and are combined using the bitwise or (`|`) operator.

View File

@ -1,5 +1,5 @@
--- ---
title: Valve Entity title: Valve entity
sidebar_label: Valve sidebar_label: Valve
--- ---
@ -19,7 +19,7 @@ Properties should always only return information from memory and not do I/O (lik
| is_opening | <code>bool &#124; None</code> | `None` | If the valve is opening or not. Used to determine `state`. | is_opening | <code>bool &#124; None</code> | `None` | If the valve is opening or not. Used to determine `state`.
| reports_position | <code>bool</code> | **Required** | If the valve knows its position or not. | reports_position | <code>bool</code> | **Required** | If the valve knows its position or not.
### Device Classes ### Device classes
| Constant | Description | Constant | Description
|----------|-----------------------| |----------|-----------------------|
@ -36,7 +36,7 @@ Properties should always only return information from memory and not do I/O (lik
| `STATE_CLOSING` | The valve is in the process of closing to reach a set position. | `STATE_CLOSING` | The valve is in the process of closing to reach a set position.
| `STATE_CLOSED` | The valve has reach the closed position. | `STATE_CLOSED` | The valve has reach the closed position.
## Supported Features ## Supported features
Supported features are defined by using values in the `ValveEntityFeature` enum Supported features are defined by using values in the `ValveEntityFeature` enum
and are combined using the bitwise or (`|`) operator. and are combined using the bitwise or (`|`) operator.

View File

@ -1,6 +1,6 @@
--- ---
title: Wake Word Detection Entity title: Wake word detection entity
sidebar_label: Wake Word Detection sidebar_label: Wake word detection
--- ---
A wake word detection entity allows other integrations or applications to detect wake words (also called hotwords) in an audio stream. A wake word detection entity allows other integrations or applications to detect wake words (also called hotwords) in an audio stream.

View File

@ -1,6 +1,6 @@
--- ---
title: Water Heater Entity title: Water heater entity
sidebar_label: Water Heater sidebar_label: Water heater
--- ---
Derive entity platforms from [`homeassistant.components.water_heater.WaterHeaterEntity`](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/water_heater/__init__.py) Derive entity platforms from [`homeassistant.components.water_heater.WaterHeaterEntity`](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/water_heater/__init__.py)
@ -41,7 +41,7 @@ Properties have to follow the units defined in the `temperature_unit`.
| `STATE_GAS` | Gas only mode, uses the most energy. | `STATE_GAS` | Gas only mode, uses the most energy.
| `STATE_OFF` | The water heater is off. | `STATE_OFF` | The water heater is off.
## Supported Features ## Supported features
Supported features are defined by using values in the `WaterHeaterEntityFeature` enum Supported features are defined by using values in the `WaterHeaterEntityFeature` enum
and are combined using the bitwise or (`|`) operator. and are combined using the bitwise or (`|`) operator.

View File

@ -1,5 +1,5 @@
--- ---
title: Weather Entity title: Weather entity
sidebar_label: Weather sidebar_label: Weather
--- ---
@ -32,7 +32,7 @@ Properties should always only return information from memory and not do I/O (lik
| uv_index | float | `None` | The current [UV index](https://en.wikipedia.org/wiki/Ultraviolet_index). | uv_index | float | `None` | The current [UV index](https://en.wikipedia.org/wiki/Ultraviolet_index).
| wind_bearing | float or string | `None` | The current wind bearing in azimuth angle (degrees) or 1-3 letter cardinal direction. | wind_bearing | float or string | `None` | The current wind bearing in azimuth angle (degrees) or 1-3 letter cardinal direction.
### Unit Conversion ### Unit conversion
Properties have to follow the units mentioned on the respective unit of measurement in the table. Properties have to follow the units mentioned on the respective unit of measurement in the table.
@ -64,7 +64,7 @@ These weather conditions are included in our translation files and also show the
This means that the `weather` platforms don't need to support languages. This means that the `weather` platforms don't need to support languages.
## Supported Features ## Supported features
Supported features are defined by using values in the `WeatherEntityFeature` enum Supported features are defined by using values in the `WeatherEntityFeature` enum
and are combined using the bitwise or (`|`) operator. and are combined using the bitwise or (`|`) operator.

View File

@ -15,7 +15,7 @@ The Assist API is equivalent to the capabilities and exposed entities that are a
The LLM API needs to be integrated in two places in your integration. Users need to be able to configure which API should be used, and the tools offered by the API should be passed to the LLM when interacting with it. The LLM API needs to be integrated in two places in your integration. Users need to be able to configure which API should be used, and the tools offered by the API should be passed to the LLM when interacting with it.
### Options Flow ### Options flow
The chosen API should be stored in the config entry options. It should hold a string reference to the API id. If no API is selected, the key must be omitted. The chosen API should be stored in the config entry options. It should hold a string reference to the API id. If no API is selected, the key must be omitted.

View File

@ -1,5 +1,5 @@
--- ---
title: "Application Credentials" title: "Application credentials"
--- ---
Integrations may support [Configuration via OAuth2](/docs/config_entries_config_flow_handler#configuration-via-oauth2) allowing Integrations may support [Configuration via OAuth2](/docs/config_entries_config_flow_handler#configuration-via-oauth2) allowing

View File

@ -1,8 +1,8 @@
--- ---
title: "Raising Exceptions" title: "Raising exceptions"
--- ---
## Raising Exceptions in service handlers ## Raising exceptions in service handlers
Operations like service calls and entity methods (e.g. *Set HVAC Mode*) should raise exceptions properly. Operations like service calls and entity methods (e.g. *Set HVAC Mode*) should raise exceptions properly.
@ -10,6 +10,6 @@ Integrations should raise `ServiceValidationError` (instead of `ValueError`) in
For other failures such as a problem communicating with a device, `HomeAssistantError` should be raised. Note that the exception stack trace will be printed to the log in this case. For other failures such as a problem communicating with a device, `HomeAssistantError` should be raised. Note that the exception stack trace will be printed to the log in this case.
## Localizing Exceptions ## Localizing exceptions
Home Assistant [supports localization](/docs/internationalization/core/#exceptions) for `HomeAssistantError` and its subclasses like `ServiceValidationError`. Home Assistant [supports localization](/docs/internationalization/core/#exceptions) for `HomeAssistantError` and its subclasses like `ServiceValidationError`.

View File

@ -1,5 +1,5 @@
--- ---
title: "Reproduce State" title: "Reproduce state"
--- ---
Home Assistant has support for scenes. Scenes are a collection of (partial) entity states. When a scene is activated, Home Assistant will try to call the right services to get the specified scenes in their specified state. Home Assistant has support for scenes. Scenes are a collection of (partial) entity states. When a scene is activated, Home Assistant will try to call the right services to get the specified scenes in their specified state.

View File

@ -1,5 +1,5 @@
--- ---
title: "Significant Change" title: "Significant change"
--- ---
Home Assistant doesn't only collect data, it also exports data to various services. Not all of these services are interested in every change. To help these services filter insignificant changes, your entity integration can add significant change support. Home Assistant doesn't only collect data, it also exports data to various services. Not all of these services are interested in every change. To help these services filter insignificant changes, your entity integration can add significant change support.