Change i.e. and e.g. to i.e.,, and e.g., (home-assistant#12162)

* Change i.e. and e.g. to i.e.,, and e.g., * Update textlintrc.json * Update .textlintrc.json Co-Authored-By: Franck Nijhof <[email protected]> * added i.e., Co-authored-by: Franck Nijhof <[email protected]>
Thrilleratplay · Feb 22, 2020 · aa7a018 · aa7a018
1 parent 42c9d5d
commit aa7a018
Show file tree

Hide file tree

Showing 83 changed files with 263 additions and 261 deletions.
diff --git a/.textlintrc.json b/.textlintrc.json
@@ -303,6 +303,7 @@
         ["colour", "color"],
         ["config\\b", "configuration"],
         ["DarkSky", "Dark Sky"],
+        ["e\\.g\\.", "e.g.,"],
         ["end ?to ?end", "end-to-end"],
         ["FRITZ!? ?Box", "FRITZ!Box"],
         ["grey", "gray"],
@@ -313,6 +314,7 @@
         ["he or she", "they"],
         ["he/she", "they"],
         ["Home-?Ass?s?iss?tt?ant", "Home Assistant"],
+        ["i\\.e\\.", "i.e.,"],
         ["IFF?TTT?T?", "IFTTT"],
         ["ISY ?994", "ISY994"],
         ["JSONRPC", "JSON-RPC"],

diff --git a/source/_docs/automation/trigger.markdown b/source/_docs/automation/trigger.markdown
@@ -182,9 +182,9 @@ Use quotes around your values for `from` and `to` to avoid the YAML parser inter
 
 #### Sunset / Sunrise trigger
 
-Triggers when the sun is setting or rising, i.e. when the sun elevation reaches 0°.
+Triggers when the sun is setting or rising, i.e., when the sun elevation reaches 0°.
 
-An optional time offset can be given to have it trigger a set time before or after the sun event (e.g. 45 minutes before sunset).
+An optional time offset can be given to have it trigger a set time before or after the sun event (e.g.,  45 minutes before sunset).
 
 <div class='note'>
 

diff --git a/source/_docs/backend/database.markdown b/source/_docs/backend/database.markdown
@@ -4,7 +4,7 @@ description: "Details about the database used by Home Assistant."
 redirect_from: /details/database/
 ---
 
-Database is used in by Home Assistant as history and tracker only, to store the events and its parameters. The default database used by Home Assistant is [SQLite](https://www.sqlite.org/), and the database file is stored in your [configuration directory](/getting-started/configuration/) (e.g., `<path to config dir>/.homeassistant/home-assistant_v2.db`). If you prefer to run a database server (e.g. PostgreSQL), use the [`recorder` component](/integrations/recorder/).
+Database is used in by Home Assistant as history and tracker only, to store the events and its parameters. The default database used by Home Assistant is [SQLite](https://www.sqlite.org/), and the database file is stored in your [configuration directory](/getting-started/configuration/) (e.g., `<path to config dir>/.homeassistant/home-assistant_v2.db`). If you prefer to run a database server (e.g.,  PostgreSQL), use the [`recorder` component](/integrations/recorder/).
 
 To work with the SQLite database manually from the command-line, you will need an [installation](http://www.sqlitetutorial.net/download-install-sqlite/) of `sqlite3`. Alternatively [DB Browser for SQLite](http://sqlitebrowser.org/) provides a viewer for exploring the database data and an editor for executing SQL commands.
 First load your database with `sqlite3`:

diff --git a/source/_docs/configuration/templating.markdown b/source/_docs/configuration/templating.markdown
@@ -175,7 +175,7 @@ The same thing can also be expressed as a filter:
   - For specific values: `utcnow().second`, `utcnow().minute`, `utcnow().hour`, `utcnow().day`, `utcnow().month`, `utcnow().year`, `utcnow().weekday()` and `utcnow().isoweekday()`.
 - `as_timestamp()` converts datetime object or string to UNIX timestamp. This function also be used as a filter.
 - `strptime(string, format)` parses a string based on a [format](https://docs.python.org/3.8/library/datetime.html#strftime-and-strptime-behavior) and returns a datetime object.
-- `relative_time` converts datetime object to its human-friendly "age" string. The age can be in second, minute, hour, day, month or year (but only the biggest unit is considered, e.g. if it's 2 days and 3 hours, "2 days" will be returned). Note that it only works for dates _in the past_.
+- `relative_time` converts datetime object to its human-friendly "age" string. The age can be in second, minute, hour, day, month or year (but only the biggest unit is considered, e.g.,  if it's 2 days and 3 hours, "2 days" will be returned). Note that it only works for dates _in the past_.
 - Filter `timestamp_local` converts an UNIX timestamp to its string representation as date/time in your local timezone.
 - Filter `timestamp_utc` converts a UNIX timestamp to its string representation representation as date/time in UTC timezone.
 - Filter `timestamp_custom(format_string, local_time=True)` converts an UNIX timestamp to its string representation based on a custom format, the use of a local timezone is default. Supports the standard [Python time formatting options](https://docs.python.org/3/library/time.html#time.strftime).  

diff --git a/source/_docs/ecosystem/appdaemon/api.markdown b/source/_docs/ecosystem/appdaemon/api.markdown
@@ -1966,7 +1966,7 @@ A list of split devices with 1 or more entries.
 
 ```python
 for sensor in self.split_device_list(self.args["sensors"]):
-    do_something(sensor)  # e.g. make a state subscription
+    do_something(sensor)  # e.g.,  make a state subscription
 ```
 
 

diff --git a/source/_docs/ecosystem/backup/backup_github.markdown b/source/_docs/ecosystem/backup/backup_github.markdown
@@ -50,7 +50,7 @@ Creating a `.gitignore` file in your repository will tell Git which files NOT to
 
 <div class='note'>
 
-  If you are creating the `.gitignore` file on Windows, make sure that you save the file with Unix line endings (i.e. by using an editor like Notepad++).
+  If you are creating the `.gitignore` file on Windows, make sure that you save the file with Unix line endings (i.e., by using an editor like Notepad++).
 
 </div>
 

diff --git a/source/_docs/installation/updating.markdown b/source/_docs/installation/updating.markdown
@@ -36,7 +36,7 @@ For a Raspberry Pi Docker container, simply pull the latest one:
 sudo docker pull homeassistant/raspberrypi3-homeassistant:latest
 ```
 
-After updating, you must start/restart Home Assistant for the changes to take effect. This means that you will have to restart `hass` itself or the [autostarting](/docs/autostart/) daemon (if applicable). Startup can take considerable amount of time (i.e. minutes) depending on your device. This is because all requirements are updated as well.
+After updating, you must start/restart Home Assistant for the changes to take effect. This means that you will have to restart `hass` itself or the [autostarting](/docs/autostart/) daemon (if applicable). Startup can take considerable amount of time (i.e., minutes) depending on your device. This is because all requirements are updated as well.
 
 [BRUH automation](https://www.bruhautomation.io/) has created [a tutorial video](https://www.youtube.com/watch?v=tuG2rs1Cl2Y) explaining how to upgrade Home Assistant.
 

diff --git a/source/_docs/z-wave/installation.markdown b/source/_docs/z-wave/installation.markdown
@@ -123,7 +123,7 @@ You can also check what hardware has been found using the [`ha` command](/hassio
 ha hardware info
 ```
 
-If you did an alternative install of Home Assistant on Linux (e.g. installing Ubuntu, then Docker, then Home Assistant Supervised) then the `modemmanager` package will interfere with any Z-Wave (or Zigbee) stick and should be removed or disabled in the host OS. Failure to do so will result in random failures of those components, e.g. dead or unreachable Z-Wave nodes, most notably right after Home Assistant restarts. Connect to your host OS via SSH, then you can disable with `sudo systemctl disable ModemManager` and remove with `sudo apt-get purge modemmanager` (commands are for Debian/Ubuntu).
+If you did an alternative install of Home Assistant on Linux (e.g.,  installing Ubuntu, then Docker, then Home Assistant Supervised) then the `modemmanager` package will interfere with any Z-Wave (or Zigbee) stick and should be removed or disabled in the host OS. Failure to do so will result in random failures of those components, e.g.,  dead or unreachable Z-Wave nodes, most notably right after Home Assistant restarts. Connect to your host OS via SSH, then you can disable with `sudo systemctl disable ModemManager` and remove with `sudo apt-get purge modemmanager` (commands are for Debian/Ubuntu).
 
 ### Docker
 
@@ -227,7 +227,7 @@ If this applies to your situation:
 
 Then chances are high that the ModemManager in the host OS is causing the issue, claiming or interfering with the USB Z-Wave stick like the much used Aeotec ones. In this case you need to disable ModemManager.
 
-Connect to your host OS (e.g. Ubuntu) through SSH, then execute the following command on your host system to disable the ModemManager:
+Connect to your host OS (e.g.,  Ubuntu) through SSH, then execute the following command on your host system to disable the ModemManager:
 
  ```bash
 systemctl disable ModemManager.service

diff --git a/source/_integrations/abode.markdown b/source/_integrations/abode.markdown
@@ -92,7 +92,7 @@ Field | Description
 `event_type` | The type of the event.
 `event_utc` | The UTC timestamp of the event.
 `user_name` | The Abode user that triggered the event, if applicable.
-`app_type` | The Abode app that triggered the event (e.g. web app, iOS app, etc.).
+`app_type` | The Abode app that triggered the event (e.g.,  web app, iOS app, etc.).
 `event_by` | The keypad user that triggered the event.
 `date` | The date of the event in the format `MM/DD/YYYY`.
 `time` | The time of the event in the format `HH:MM AM`.

diff --git a/source/_integrations/aftership.markdown b/source/_integrations/aftership.markdown
@@ -49,7 +49,7 @@ api_key:
 | Service data attribute | Required | Type | Description |
 | ---------------------- | -------- | -------- | ----------- |
 | `tracking_number` | `True` | string | Tracking number
-| `slug` | `False` | string | Carrier e.g. `fedex`
+| `slug` | `False` | string | Carrier e.g.,  `fedex`
 | `title` | `False` | string | Friendly name of package
 
 ## Service `remove_tracking`
@@ -59,7 +59,7 @@ api_key:
 | Service data attribute | Required | Type | Description |
 | ---------------------- | -------- | -------- | ----------- |
 | `tracking_number` | `True` | string | Tracking number
-| `slug` | `True` | string | Carrier e.g. `fedex`
+| `slug` | `True` | string | Carrier e.g.,  `fedex`
 
 <div class='note info'>
 This integration retrieves data from AfterShip public REST API, but the integration is not affiliated with AfterShip.

diff --git a/source/_integrations/alexa.smart_home.markdown b/source/_integrations/alexa.smart_home.markdown
@@ -340,7 +340,7 @@ See [List of Capability Interfaces and Supported Locales][alexa-supported-locale
 
 ### Proactive Events
 
-The `endpoint`, `client_id` and `client_secret` are optional, and are only required if you want to enable Alexa's proactive mode (i.e. "Send Alexa Events" enabled). Please note the following if you want to enable proactive mode:
+The `endpoint`, `client_id` and `client_secret` are optional, and are only required if you want to enable Alexa's proactive mode (i.e., "Send Alexa Events" enabled). Please note the following if you want to enable proactive mode:
 
 - There are different endpoint URLs, depending on the region of your skill. Please check the available endpoints at <https://developer.amazon.com/docs/smarthome/send-events-to-the-alexa-event-gateway.html#endpoints>
 - The `client_id` and `client_secret` are not the ones used by the skill that have been set up using "Login with Amazon" (in the [Alexa Developer Console][amazon-dev-console]: Build > Account Linking), but rather from the "Alexa Skill Messaging" (in the Alexa Developer Console: Build > Permissions > Alexa Skill Messaging). To get them, you need to enable the "Send Alexa Events" permission.

diff --git a/source/_integrations/ambiclimate.markdown b/source/_integrations/ambiclimate.markdown
@@ -13,7 +13,7 @@ ha_codeowners:
 Integrates [Ambiclimate](https://ambiclimate.com/) Air Conditioning controller into Home Assistant.
 
 You must create an application [here](https://api.ambiclimate.com/clients) to obtain a `client_id` and `client_secret`.
-The `callback url` should be configured as your Home Assistant `base_url` + `/api/ambiclimate`, e.g. `https://example.com/api/ambiclimate`.
+The `callback url` should be configured as your Home Assistant `base_url` + `/api/ambiclimate`, e.g.,  `https://example.com/api/ambiclimate`.
 
 To enable this platform, add the following lines to your `configuration.yaml` file:
 

diff --git a/source/_integrations/binary_sensor.template.markdown b/source/_integrations/binary_sensor.template.markdown
@@ -238,7 +238,7 @@ binary_sensor:
 
 ### Device Tracker sensor with Latitude and Longitude Attributes
 
-This example shows how to combine a non-GPS (e.g. NMAP) and GPS device tracker while still including latitude and longitude attributes
+This example shows how to combine a non-GPS (e.g.,  NMAP) and GPS device tracker while still including latitude and longitude attributes
 
 {% raw %}
 ```yaml

diff --git a/source/_integrations/bom.markdown b/source/_integrations/bom.markdown
@@ -122,7 +122,7 @@ camera:
 
 In the event BOM creates a new radar, or a radar's ID changes, you may define a custom `id` along with corresponding `delta` and `frames` values. You may also specify custom `delta` and `frames` values, along with a valid `location`, to override the default values for an existing radar. You may not define `location` and `id` in the same entity; you must specify one or the other. If `id` is specified, then `delta` and `frames` values _must_ be provided. If `location` is specified, `delta` and `frames` _may_ be provided to override the default values.
 
-To find a live radar ID (e.g. for the `Townsville` radar), visit the [BOM website's radars page](http://www.bom.gov.au/australia/radar/), click the link for the radar you are interested in, and note the URL, for example: `http://www.bom.gov.au/products/IDR733.loop.shtml`. The ID is the number following `IDR` (i.e. `733`) in the URL. You can also see, at the bottom of the radar image, a rotating set of times corresponding to the frames of the BOM's JavaScript-driven animation. The number of minutes (in seconds) between these times corresponds to the camera's `delta` value, and the number of frames corresponds to the `frames` value. At the time of this writing, the `Townsville` radar loop is composed of 4 frames at 10-minute (600 second) intervals. Since these are also the default values, this configuration block
+To find a live radar ID (e.g.,  for the `Townsville` radar), visit the [BOM website's radars page](http://www.bom.gov.au/australia/radar/), click the link for the radar you are interested in, and note the URL, for example: `http://www.bom.gov.au/products/IDR733.loop.shtml`. The ID is the number following `IDR` (i.e., `733`) in the URL. You can also see, at the bottom of the radar image, a rotating set of times corresponding to the frames of the BOM's JavaScript-driven animation. The number of minutes (in seconds) between these times corresponds to the camera's `delta` value, and the number of frames corresponds to the `frames` value. At the time of this writing, the `Townsville` radar loop is composed of 4 frames at 10-minute (600 second) intervals. Since these are also the default values, this configuration block
 
 ```yaml
 camera:

diff --git a/source/_integrations/caldav.markdown b/source/_integrations/caldav.markdown
@@ -103,7 +103,7 @@ calendars:
   required: false
   description: >
     List of the calendars to filter.
-    Empty or absent means no filtering, i.e. all calendars will be added.
+    Empty or absent means no filtering, i.e., all calendars will be added.
   type: list
 custom_calendars:
   required: false

diff --git a/source/_integrations/climate.knx.markdown b/source/_integrations/climate.knx.markdown
@@ -48,7 +48,7 @@ climate:
     operation_mode_state_address: '5/1/8'
 ```
 
-If your device doesn't support setpoint_shift calculations (i.e. if you don't provide a `setpoint_shift_address` value) please set the `min_temp` and `max_temp`
+If your device doesn't support setpoint_shift calculations (i.e., if you don't provide a `setpoint_shift_address` value) please set the `min_temp` and `max_temp`
 attributes of the climate device to avoid issues with exceeding valid temperature values in the frontend. Please do also make sure to add the `target_temperature_address`
 to the configuration in this case.:
 

diff --git a/source/_integrations/coinbase.markdown b/source/_integrations/coinbase.markdown
@@ -44,7 +44,7 @@ exchange_rate_currencies:
   type: list
 {% endconfiguration %}
 
-Possible currencies are codes that conform to the ISO 4217 standard where possible. Currencies which have or had no representation in ISO 4217 may use a custom code (e.g. BTC). A list of values can be obtained via https://api.coinbase.com/v2/currencies, for more information visit [the Coinbase API documentation](https://developers.coinbase.com/api/v2#get-currencies).
+Possible currencies are codes that conform to the ISO 4217 standard where possible. Currencies which have or had no representation in ISO 4217 may use a custom code (e.g.,  BTC). A list of values can be obtained via https://api.coinbase.com/v2/currencies, for more information visit [the Coinbase API documentation](https://developers.coinbase.com/api/v2#get-currencies).
 
 ## Full configuration example
 

diff --git a/source/_integrations/cover.mqtt.markdown b/source/_integrations/cover.mqtt.markdown
@@ -25,7 +25,7 @@ If a state topic and position topic are not defined, the cover will work in opti
 
 Optimistic mode can be forced, even if a `state_topic` / `position_topic` is defined. Try to enable it if experiencing incorrect cover operation (Google Assistant gauge may need optimistic mode as it often send request to your Home Assistant immediately after send set_cover_position in which case MQTT could be too slow).
 
-The `mqtt` cover platform optionally supports an `availability_topic` to receive online and offline messages (birth and LWT messages) from the MQTT cover device. During normal operation, if the MQTT cover device goes offline (i.e. publishes `payload_not_available` to `availability_topic`), Home Assistant will display the cover as "unavailable". If these messages are published with the `retain` flag set, the cover will receive an instant update after subscription and Home Assistant will display correct availability state of the cover when Home Assistant starts up. If the `retain` flag is not set, Home Assistant will display the cover as "unavailable" when Home Assistant starts up.
+The `mqtt` cover platform optionally supports an `availability_topic` to receive online and offline messages (birth and LWT messages) from the MQTT cover device. During normal operation, if the MQTT cover device goes offline (i.e., publishes `payload_not_available` to `availability_topic`), Home Assistant will display the cover as "unavailable". If these messages are published with the `retain` flag set, the cover will receive an instant update after subscription and Home Assistant will display correct availability state of the cover when Home Assistant starts up. If the `retain` flag is not set, Home Assistant will display the cover as "unavailable" when Home Assistant starts up.
 
 To use your MQTT cover in your installation, add the following to your `configuration.yaml` file:
 

diff --git a/source/_integrations/delijn.markdown b/source/_integrations/delijn.markdown
@@ -42,7 +42,7 @@ next_departure:
   type: list
   keys:
     stop_id:
-      description: "ID of the stop, e.g. `200552`."
+      description: "ID of the stop, e.g.,  `200552`."
       required: true
       type: string
     number_of_departures:

diff --git a/source/_integrations/denonavr.markdown b/source/_integrations/denonavr.markdown
@@ -97,11 +97,11 @@ A few notes:
 
 #### Service `denonavr.get_command`
 
-Generic commands are supported, in particular, any command supported by the telnet protocol can be sent to `/goform/formiPhoneAppDirect.xml`, e.g., `/goform/formiPhoneAppDirect.xml?VSMONI2` to switch HDMI outputs on supported receivers. IR remote codes can also be sent to this endpoint, e.g. "/goform/formiPhoneAppDirect.xml?RCKSK0410370" as a mute toggle. A comprehensive list of telnet protocol commands is available at <https://ca.denon.com/ca/product/hometheater/receivers/avrx4400h?docname=AVR-X6400H_X4400H_X3400H_X2400H_X1400H_S930H_S730H_PROTOCOL_V01.xlsx> and a full list of IR codes at <http://www.denon-hifi.nl/uk/product/hometheater/avreceivers/avr3313?docname=AVR3313_IR_CODE_V01.pdf>
+Generic commands are supported, in particular, any command supported by the telnet protocol can be sent to `/goform/formiPhoneAppDirect.xml`, e.g., `/goform/formiPhoneAppDirect.xml?VSMONI2` to switch HDMI outputs on supported receivers. IR remote codes can also be sent to this endpoint, e.g.,  "/goform/formiPhoneAppDirect.xml?RCKSK0410370" as a mute toggle. A comprehensive list of telnet protocol commands is available at <https://ca.denon.com/ca/product/hometheater/receivers/avrx4400h?docname=AVR-X6400H_X4400H_X3400H_X2400H_X1400H_S930H_S730H_PROTOCOL_V01.xlsx> and a full list of IR codes at <http://www.denon-hifi.nl/uk/product/hometheater/avreceivers/avr3313?docname=AVR3313_IR_CODE_V01.pdf>
 
 | Service data attribute | Optional | Description                                          |
 | ---------------------- | -------- | ---------------------------------------------------- |
 | `entity_id`            |       no | Name of entity to send command to. For example `media_player.marantz`|
-| `command`              |       no | Command to send to device, e.g. `/goform/formiPhoneAppDirect.xml?VSMONI2`|
+| `command`              |       no | Command to send to device, e.g.,  `/goform/formiPhoneAppDirect.xml?VSMONI2`|
 
 [Denon]: /integrations/denon
-Original file line number
+Diff line change
@@ Expand Up @@
     <div class='note'>
-      If you are creating the `.gitignore` file on Windows, make sure that you save the file with Unix line endings (i.e. by using an editor like Notepad++).
+      If you are creating the `.gitignore` file on Windows, make sure that you save the file with Unix line endings (i.e., by using an editor like Notepad++).
     </div>
@@ Expand Down @@