From 84b21aa5d57768a8df4f0bba08ba35bd39c14711 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ville=20Skytt=C3=A4?= Date: Fri, 17 Jan 2020 22:53:25 +0200 Subject: [PATCH] Spelling and grammar fixes (#392) --- docs/app_integration_notifications.md | 2 +- docs/app_integration_sensors.md | 4 ++-- docs/device_automation_condition.md | 2 +- docs/documentation_standards.md | 2 +- docs/entity_cover.md | 4 ++-- docs/hassio_addon_config.md | 2 +- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/app_integration_notifications.md b/docs/app_integration_notifications.md index dd2eed6c..f85e83d7 100644 --- a/docs/app_integration_notifications.md +++ b/docs/app_integration_notifications.md @@ -2,7 +2,7 @@ title: "Push Notifications" --- -The `mobile_app` component has a notify platform built in that allows for a generic way to send push notifications to your users without requiring installation of a external custom component. +The `mobile_app` component has a notify platform built in that allows for a generic way to send push notifications to your users without requiring installation of an external custom component. ## Enabling push notifications diff --git a/docs/app_integration_sensors.md b/docs/app_integration_sensors.md index a2ad7233..f368240a 100644 --- a/docs/app_integration_sensors.md +++ b/docs/app_integration_sensors.md @@ -38,7 +38,7 @@ The valid keys are: | name | string | Yes | The name of the sensor | | state | bool, float, int, string | Yes | The state of the sensor | | type | string | Yes | The type of the sensor. Must be one of `binary_sensor` or `sensor` | -| unique_id | string | Yes | A identifier unique to this installation of your app. You'll need this later. Usually best when its a safe version of the sensor name | +| unique_id | string | Yes | An identifier unique to this installation of your app. You'll need this later. Usually best when its a safe version of the sensor name | | unit_of_measurement | string | No | The unit of measurement for the sensor | Sensors will appear as soon as they are registered. @@ -74,5 +74,5 @@ Only some of the keys are allowed during updates: | icon | Material Design Icon (string) | No | Must be prefixed `mdi:` | | state | bool, float, int, string | Yes | The state of the sensor | | type | string | Yes | The type of the sensor. Must be one of `binary_sensor` or `sensor` | -| unique_id | string | Yes | A identifier unique to this installation of your app. You'll need this later. Usually best when its a safe version of the sensor name | +| unique_id | string | Yes | An identifier unique to this installation of your app. You'll need this later. Usually best when its a safe version of the sensor name | diff --git a/docs/device_automation_condition.md b/docs/device_automation_condition.md index 9af6d72f..a9d0bf14 100644 --- a/docs/device_automation_condition.md +++ b/docs/device_automation_condition.md @@ -5,7 +5,7 @@ sidebar_label: Conditions Device conditions allow a user to check if a certain condition is met. Examples are is a light on or is the floor wet. -Device conditions are defined as dictionaries. These dictionaries are created by your integration and are passed to your integration to create a a function that checks the condition. +Device conditions are defined as dictionaries. These dictionaries are created by your integration and are passed to your integration to create a function that checks the condition. Device conditions can be provided by the integration that provides the device (e.g. ZHA, deCONZ) or the entity integrations that the device has entities with (e.g. light, humidity sensor). An example of the latter could be to check if a light is on or the floor is wet. diff --git a/docs/documentation_standards.md b/docs/documentation_standards.md index 3b94eb82..619ff240 100644 --- a/docs/documentation_standards.md +++ b/docs/documentation_standards.md @@ -65,7 +65,7 @@ some_key: ## Renaming Pages -It can happen that a integration or platform is renamed, in this case the documentation needs to be updated as well. If you rename a page, add `redirect_from:` to the file header and let it point to the old location/name of the page. Please consider to add details, like release number or old integration/platform name, to the page in a [note](/developers/documentation/create_page/#html). +It can happen that an integration or platform is renamed, in this case the documentation needs to be updated as well. If you rename a page, add `redirect_from:` to the file header and let it point to the old location/name of the page. Please consider to add details, like release number or old integration/platform name, to the page in a [note](/developers/documentation/create_page/#html). ```text --- diff --git a/docs/entity_cover.md b/docs/entity_cover.md index 483aa8a8..fcd3ea46 100644 --- a/docs/entity_cover.md +++ b/docs/entity_cover.md @@ -19,7 +19,7 @@ A cover entity is a device that controls an opening or cover, such as a garage d | is_closing | bool | None | If the cover is closing or not. Used to determine `state`. | is_closed | bool | `NotImplementedError()` | If the cover is closed or not. if the state is unknown, return `None`. Used to determine `state`. -### Entity Properties (base class properties which may be overriden) +### Entity Properties (base class properties which may be overridden) | Name | Type | Default | Description | ---- | ---- | ------- | ----------- @@ -35,7 +35,7 @@ A cover entity is a device that controls an opening or cover, such as a garage d | `DEVICE_CLASS_DAMPER` | Control of a mechanical damper that reduces air flow, sound, or light. | `DEVICE_CLASS_DOOR` | Control of a door or gate that provides access to an area. | `DEVICE_CLASS_GARAGE` | Control of a garage door that provides access to a garage. -| `DEVICE_CLASS_SHADE` | Control of shades, which are a continous plane of material or connected cells that expanded or collapsed over an opening, such as window shades. +| `DEVICE_CLASS_SHADE` | Control of shades, which are a continuous plane of material or connected cells that expanded or collapsed over an opening, such as window shades. | `DEVICE_CLASS_SHUTTER` | Control of shutters, which are linked slats that swing out/in to cover an opening or may be tilted to partially cover an opening, such as indoor or exterior window shutters. | `DEVICE_CLASS_WINDOW` | Control of a physical window that opens and closes or may tilt. diff --git a/docs/hassio_addon_config.md b/docs/hassio_addon_config.md index 994317f3..8a741e41 100644 --- a/docs/hassio_addon_config.md +++ b/docs/hassio_addon_config.md @@ -122,7 +122,7 @@ The config for an add-on is stored in `config.json`. | host_dbus | bool | no | Default False. Map Host dbus service into add-on. | host_pid | bool | no | Default False. Allow to run container on host PID namespace. Work only for not protected add-ons. | devices | list | no | Device list to map into the add-on. Format is: `::`. i.e. `/dev/ttyAMA0:/dev/ttyAMA0:rwm` -| udev | bool | no | Default False. Set this True, if your container run a own udev process. +| udev | bool | no | Default False. Set this True, if your container runs a udev process of its own. | auto_uart | bool | no | Default False. Auto mapping all UART/Serial device from host into add-on. | homeassistant | string | no | Pin a minimum required Home Assistant version for such Add-on. Value is a version string like `0.91.2`. | hassio_role | str | no | Default `default`. Role based access to Hass.io API. Available: `default`, `homeassistant`, `backup`, `manager`, `admin`.