Skip to content

Commit 16b9e46

Browse files
authored
Fix some typos in documentation (found by codespell) (#2837)
Signed-off-by: Stefan Weil <[email protected]>
1 parent 3b5b8d8 commit 16b9e46

18 files changed

+21
-21
lines changed

docs/api/supervisor/endpoints.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3074,7 +3074,7 @@ Dismiss an issue
30743074

30753075
<ApiEndpoint path="/resolution/healthcheck" method="post">
30763076

3077-
Execute a healthcheck and autofix & notifcation.
3077+
Execute a healthcheck and autofix & notification.
30783078

30793079
</ApiEndpoint>
30803080

docs/auth_permissions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ if not user.permissions.check_entity(entity_id, POLICY_CONTROL):
130130

131131
All service actions, fired events and states in Home Assistant have a context object. This object allows us to attribute changes to events and actions. These context objects also contain a user id, which is used for checking the permissions.
132132

133-
It's crucial for permission checking that actions taken on behalf of the user are done with a context containing the user ID. If you are in a service action handler, you should re-use the incoming context `call.context`. If you are inside a WebSocket API or Rest API endpoint, you should create a context with the correct user:
133+
It's crucial for permission checking that actions taken on behalf of the user are done with a context containing the user ID. If you are in a service action handler, you should reuse the incoming context `call.context`. If you are inside a WebSocket API or Rest API endpoint, you should create a context with the correct user:
134134

135135
```python
136136
from homeassistant.core import Context

docs/config_entries_config_flow_handler.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ When the translations are merged into Home Assistant, they will be automatically
238238

239239
As mentioned above - each Config Entry has a version assigned to it. This is to be able to migrate Config Entry data to new formats when Config Entry schema changes.
240240

241-
Migration can be handled programatically by implementing function `async_migrate_entry` in your integration's `__init__.py` file. The function should return `True` if migration is successful.
241+
Migration can be handled programmatically by implementing function `async_migrate_entry` in your integration's `__init__.py` file. The function should return `True` if migration is successful.
242242

243243
The version is made of a major and minor version. If minor versions differ but major versions are the same, integration setup will be allowed to continue even if the integration does not implement `async_migrate_entry`. This means a minor version bump is backwards compatible unlike a major version bump which causes the integration to fail setup if the user downgrades Home Assistant Core without restoring their configuration from backup.
244244

docs/core/entity/calendar.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ and are combined using the bitwise or (`|`) operator.
5252

5353
### Get events
5454

55-
A calendar entity can return events that occur during a particular time range. Some notes for implementors:
55+
A calendar entity can return events that occur during a particular time range. Some notes for implementers:
5656

5757
- The `start_date` is the lower bound and applied to the event's `end` (exclusive). This has a `tzinfo` of the local Home Assistant timezone.
5858
- The `end_date` is the upper bound and applied to the event's `start` (exclusive). This has the same `tzinfo` as `start_date`.

docs/core/entity/camera.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ When the width and height are passed, scaling should be done on a best-effort ba
5151

5252
- Return the smallest image that meets the minimum width and minimum height.
5353

54-
- When scaling the image, aspect ratio must be preserved. If the aspect ratio is not the same as the requsted height or width, it is expected that the width and/or height of the returned image will be larger than requested.
54+
- When scaling the image, aspect ratio must be preserved. If the aspect ratio is not the same as the requested height or width, it is expected that the width and/or height of the returned image will be larger than requested.
5555

5656
- Pass on the width and height if the underlying camera is capable of scaling the image.
5757

docs/core/entity/fan.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ class FanEntity(ToggleEntity):
161161

162162
:::tip `speed` is deprecated.
163163

164-
For new intergrations, `speed` should not be implemented and only `percentage` and `preset_mode` should be used.
164+
For new integrations, `speed` should not be implemented and only `percentage` and `preset_mode` should be used.
165165

166166
:::
167167

docs/core/entity/number.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ If specifying a device class, your number entity will need to also return the co
9090

9191
## Restoring number states
9292

93-
Numbers which restore the state after restart or reload should not extend `RestoreEntity` because that does not store the `native_value`, but instead the `state` which may have been modifed by the number base entity. Numbers which restore the state should extend `RestoreNumber` and call `await self.async_get_last_number_data` from `async_added_to_hass` to get access to the stored `native_min_value`, `native_max_value`, `native_step`, `native_unit_of_measurement` and `native_value`.
93+
Numbers which restore the state after restart or reload should not extend `RestoreEntity` because that does not store the `native_value`, but instead the `state` which may have been modified by the number base entity. Numbers which restore the state should extend `RestoreNumber` and call `await self.async_get_last_number_data` from `async_added_to_hass` to get access to the stored `native_min_value`, `native_max_value`, `native_step`, `native_unit_of_measurement` and `native_value`.
9494

9595
## Methods
9696

docs/core/platform/repairs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,4 +116,4 @@ ir.async_delete_issue(hass, DOMAIN, "manual_migration")
116116

117117
## Fixing an issue
118118

119-
If an issue has the `is_fixable` issue set to `True`, the user will be allowed to fix the issue. An issue which is succesfully fixed will be removed from the issue registry.
119+
If an issue has the `is_fixable` issue set to `True`, the user will be allowed to fix the issue. An issue which is successfully fixed will be removed from the issue registry.

docs/creating_integration_manifest.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ it thus will become mandatory in the future.
6767
| ---- | -----------
6868
| `device` | Provides a single device like, for example, ESPHome. |
6969
| `entity` | Provides a basic entity platform, like sensor or light. This should generally not be used. |
70-
| `hardware` | Provides a hardware integration, like Raspbery Pi or Hardkernel. This should generally not be used. |
70+
| `hardware` | Provides a hardware integration, like Raspberry Pi or Hardkernel. This should generally not be used. |
7171
| `helper` | Provides an entity to help the user with automations like input boolean, derivative or group. |
7272
| `hub` | Provides a hub integration, with multiple devices or services, like Philips Hue. |
7373
| `service` | Provides a single service, like DuckDNS or AdGuard. |
@@ -370,10 +370,10 @@ Example with setting `registered_devices` to `true`:
370370

371371
## USB
372372

373-
If your integration supports discovery via usb, you can add the type to your manifest. If the user has the `usb` integration loaded, it will load the `usb` step of your integration's config flow when it is discovered. We support discovery by VID (Vendor ID), PID (Device ID), Serial Number, Manufacturer, and Description by extracting these values from the USB descriptor. For help identifiying these values see [How To Identify A Device](https://wiki.debian.org/HowToIdentifyADevice/USB). The manifest value is a list of matcher dictionaries. Your integration is discovered if all items of any of the specified matchers are found in the USB data. It's up to your config flow to filter out duplicates.
373+
If your integration supports discovery via usb, you can add the type to your manifest. If the user has the `usb` integration loaded, it will load the `usb` step of your integration's config flow when it is discovered. We support discovery by VID (Vendor ID), PID (Device ID), Serial Number, Manufacturer, and Description by extracting these values from the USB descriptor. For help identifying these values see [How To Identify A Device](https://wiki.debian.org/HowToIdentifyADevice/USB). The manifest value is a list of matcher dictionaries. Your integration is discovered if all items of any of the specified matchers are found in the USB data. It's up to your config flow to filter out duplicates.
374374

375375
:::warning
376-
Some VID and PID combinations are used by many unrelated devices. For example VID `10C4` and PID `EA60` matches any Silicon Labs CP2102 USB-Serial bridge chip. When matching these type of devices, it is important to match on `description` or another identifer to avoid an unexpected discovery.
376+
Some VID and PID combinations are used by many unrelated devices. For example VID `10C4` and PID `EA60` matches any Silicon Labs CP2102 USB-Serial bridge chip. When matching these type of devices, it is important to match on `description` or another identifier to avoid an unexpected discovery.
377377
:::
378378

379379
The following example has two matchers consisting of two items. All of the items in any of the two matchers must match for discovery to happen by this config.

docs/data_entry_flow_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ To specify an icon for a section, update `icons.json` according to this example:
191191

192192
#### Labels & descriptions
193193

194-
Translations for the form are added to `strings.json` in a key for the `step_id`. That object may contain the folowing keys:
194+
Translations for the form are added to `strings.json` in a key for the `step_id`. That object may contain the following keys:
195195

196196
| Key | Value | Notes |
197197
| :----------------: | :-----------------: | :------------------------------------------------------------------------------------------------------------------------------------------- |

0 commit comments

Comments
 (0)