From 1ee7c483a764b235b881c3918e8177b982a961e6 Mon Sep 17 00:00:00 2001 From: springstan <46536646+springstan@users.noreply.github.com> Date: Fri, 21 Feb 2020 00:29:46 +0100 Subject: [PATCH] Update file headers and outdated documentation links (#32022) * Update documentation links * Update file headers v2 --- .../components/dublin_bus_transport/sensor.py | 3 --- .../components/dwd_weather_warnings/sensor.py | 3 --- homeassistant/components/dyson/fan.py | 11 ++--------- homeassistant/components/ebox/sensor.py | 3 --- .../components/eddystone_temperature/sensor.py | 3 --- .../components/environment_canada/camera.py | 7 +------ .../components/environment_canada/sensor.py | 7 +------ .../components/environment_canada/weather.py | 7 +------ homeassistant/components/fail2ban/sensor.py | 8 +------- homeassistant/components/fido/sensor.py | 3 --- homeassistant/components/flexit/climate.py | 14 +------------- homeassistant/components/flux/switch.py | 3 --- homeassistant/components/geo_rss_events/sensor.py | 3 --- homeassistant/components/izone/__init__.py | 7 +------ homeassistant/components/kodi/notify.py | 2 +- homeassistant/components/lifx_legacy/light.py | 3 --- homeassistant/components/meraki/device_tracker.py | 8 +------- homeassistant/components/mobile_app/config_flow.py | 2 +- homeassistant/components/mqtt/light/__init__.py | 7 +------ .../components/mqtt/light/schema_basic.py | 7 +------ homeassistant/components/mqtt/light/schema_json.py | 7 +------ .../components/mqtt/light/schema_template.py | 7 +------ homeassistant/components/mqtt/vacuum/__init__.py | 7 +------ homeassistant/components/neato/config_flow.py | 2 +- homeassistant/components/nest/binary_sensor.py | 2 +- homeassistant/components/nest/sensor.py | 4 ++-- homeassistant/components/onvif/camera.py | 7 +------ homeassistant/components/pandora/media_player.py | 2 +- homeassistant/components/pencom/switch.py | 6 +----- homeassistant/components/rejseplanen/sensor.py | 3 --- homeassistant/components/smarthab/__init__.py | 7 +------ homeassistant/components/smarthab/cover.py | 7 +------ homeassistant/components/smarthab/light.py | 7 +------ homeassistant/components/somfy/__init__.py | 7 +------ .../components/synology_srm/device_tracker.py | 6 +----- .../components/thermoworks_smoke/sensor.py | 3 --- homeassistant/components/uk_transport/sensor.py | 6 +----- homeassistant/components/volumio/media_player.py | 3 --- homeassistant/components/zha/core/__init__.py | 7 +------ .../components/zha/core/channels/__init__.py | 7 +------ .../components/zha/core/channels/closures.py | 7 +------ .../components/zha/core/channels/general.py | 7 +------ .../components/zha/core/channels/homeautomation.py | 7 +------ homeassistant/components/zha/core/channels/hvac.py | 7 +------ .../components/zha/core/channels/lighting.py | 7 +------ .../components/zha/core/channels/lightlink.py | 7 +------ .../zha/core/channels/manufacturerspecific.py | 7 +------ .../components/zha/core/channels/measurement.py | 7 +------ .../components/zha/core/channels/protocol.py | 7 +------ .../components/zha/core/channels/security.py | 7 +------ .../components/zha/core/channels/smartenergy.py | 7 +------ homeassistant/components/zha/core/device.py | 7 +------ homeassistant/components/zha/core/discovery.py | 7 +------ homeassistant/components/zha/core/gateway.py | 7 +------ homeassistant/components/zha/core/group.py | 7 +------ homeassistant/components/zha/core/helpers.py | 7 +------ homeassistant/components/zha/core/patches.py | 7 +------ homeassistant/components/zha/core/registries.py | 7 +------ 58 files changed, 49 insertions(+), 295 deletions(-) diff --git a/homeassistant/components/dublin_bus_transport/sensor.py b/homeassistant/components/dublin_bus_transport/sensor.py index a5fe8fd6b30..b517ecf6466 100644 --- a/homeassistant/components/dublin_bus_transport/sensor.py +++ b/homeassistant/components/dublin_bus_transport/sensor.py @@ -3,9 +3,6 @@ Support for Dublin RTPI information from data.dublinked.ie. For more info on the API see : https://data.gov.ie/dataset/real-time-passenger-information-rtpi-for-dublin-bus-bus-eireann-luas-and-irish-rail/resource/4b9f2c4f-6bf5-4958-a43a-f12dab04cf61 - -For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.dublin_public_transport/ """ from datetime import datetime, timedelta import logging diff --git a/homeassistant/components/dwd_weather_warnings/sensor.py b/homeassistant/components/dwd_weather_warnings/sensor.py index 695b839d18c..af358343d8b 100644 --- a/homeassistant/components/dwd_weather_warnings/sensor.py +++ b/homeassistant/components/dwd_weather_warnings/sensor.py @@ -1,9 +1,6 @@ """ Support for getting statistical data from a DWD Weather Warnings. -For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.dwd_weather_warnings/ - Data is fetched from DWD: https://rcccm.dwd.de/DE/wetter/warnungen_aktuell/objekt_einbindung/objekteinbindung.html diff --git a/homeassistant/components/dyson/fan.py b/homeassistant/components/dyson/fan.py index 2d41e6b828a..4ec23921c03 100644 --- a/homeassistant/components/dyson/fan.py +++ b/homeassistant/components/dyson/fan.py @@ -1,8 +1,4 @@ -"""Support for Dyson Pure Cool link fan. - -For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/fan.dyson/ -""" +"""Support for Dyson Pure Cool link fan.""" import logging from libpurecool.const import FanMode, FanSpeed, NightMode, Oscillation @@ -157,10 +153,7 @@ def setup_platform(hass, config, add_entities, discovery_info=None): ) hass.services.register( - DYSON_DOMAIN, - SERVICE_SET_AUTO_MODE, - service_handle, - schema=SET_AUTO_MODE_SCHEMA, + DYSON_DOMAIN, SERVICE_SET_AUTO_MODE, service_handle, schema=SET_AUTO_MODE_SCHEMA ) if has_purecool_devices: hass.services.register( diff --git a/homeassistant/components/ebox/sensor.py b/homeassistant/components/ebox/sensor.py index 54355ed3bb8..f1221bd1e77 100644 --- a/homeassistant/components/ebox/sensor.py +++ b/homeassistant/components/ebox/sensor.py @@ -2,9 +2,6 @@ Support for EBox. Get data from 'My Usage Page' page: https://client.ebox.ca/myusage - -For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.ebox/ """ from datetime import timedelta import logging diff --git a/homeassistant/components/eddystone_temperature/sensor.py b/homeassistant/components/eddystone_temperature/sensor.py index 3b5aa95701f..1d6ff61bf59 100644 --- a/homeassistant/components/eddystone_temperature/sensor.py +++ b/homeassistant/components/eddystone_temperature/sensor.py @@ -3,9 +3,6 @@ Read temperature information from Eddystone beacons. Your beacons must be configured to transmit UID (for identification) and TLM (for temperature) frames. - -For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.eddystone_temperature/ """ import logging diff --git a/homeassistant/components/environment_canada/camera.py b/homeassistant/components/environment_canada/camera.py index 4ef3e17fc46..d51b69f5713 100644 --- a/homeassistant/components/environment_canada/camera.py +++ b/homeassistant/components/environment_canada/camera.py @@ -1,9 +1,4 @@ -""" -Support for the Environment Canada radar imagery. - -For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/camera.environment_canada/ -""" +"""Support for the Environment Canada radar imagery.""" import datetime import logging diff --git a/homeassistant/components/environment_canada/sensor.py b/homeassistant/components/environment_canada/sensor.py index 1568ba19d6b..e6ea87fd946 100644 --- a/homeassistant/components/environment_canada/sensor.py +++ b/homeassistant/components/environment_canada/sensor.py @@ -1,9 +1,4 @@ -""" -Support for the Environment Canada weather service. - -For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.environment_canada/ -""" +"""Support for the Environment Canada weather service.""" from datetime import datetime, timedelta import logging import re diff --git a/homeassistant/components/environment_canada/weather.py b/homeassistant/components/environment_canada/weather.py index 572543e39c4..10666b4a34e 100644 --- a/homeassistant/components/environment_canada/weather.py +++ b/homeassistant/components/environment_canada/weather.py @@ -1,9 +1,4 @@ -""" -Platform for retrieving meteorological data from Environment Canada. - -For more details about this platform, please refer to the documentation -https://home-assistant.io/components/weather.environmentcanada/ -""" +"""Platform for retrieving meteorological data from Environment Canada.""" import datetime import logging import re diff --git a/homeassistant/components/fail2ban/sensor.py b/homeassistant/components/fail2ban/sensor.py index 692b48d9db5..6e47cb45966 100644 --- a/homeassistant/components/fail2ban/sensor.py +++ b/homeassistant/components/fail2ban/sensor.py @@ -1,10 +1,4 @@ -""" -Support for displaying IPs banned by fail2ban. - -For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.fail2ban/ - -""" +"""Support for displaying IPs banned by fail2ban.""" from datetime import timedelta import logging import os diff --git a/homeassistant/components/fido/sensor.py b/homeassistant/components/fido/sensor.py index f444abd25ee..9f2eeb9bd7c 100644 --- a/homeassistant/components/fido/sensor.py +++ b/homeassistant/components/fido/sensor.py @@ -3,9 +3,6 @@ Support for Fido. Get data from 'Usage Summary' page: https://www.fido.ca/pages/#/my-account/wireless - -For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.fido/ """ from datetime import timedelta import logging diff --git a/homeassistant/components/flexit/climate.py b/homeassistant/components/flexit/climate.py index 34ddd9a8ffa..8720f67f396 100644 --- a/homeassistant/components/flexit/climate.py +++ b/homeassistant/components/flexit/climate.py @@ -1,16 +1,4 @@ -""" -Platform for Flexit AC units with CI66 Modbus adapter. - -Example configuration: - -climate: - - platform: flexit - name: Main AC - slave: 21 - -For more details about this platform, please refer to the documentation -https://home-assistant.io/components/climate.flexit/ -""" +"""Platform for Flexit AC units with CI66 Modbus adapter.""" import logging from typing import List diff --git a/homeassistant/components/flux/switch.py b/homeassistant/components/flux/switch.py index f22b6335911..8ffd84a518f 100644 --- a/homeassistant/components/flux/switch.py +++ b/homeassistant/components/flux/switch.py @@ -2,9 +2,6 @@ Flux for Home-Assistant. The idea was taken from https://github.com/KpaBap/hue-flux/ - -For more details about this component, please refer to the documentation at -https://home-assistant.io/components/switch.flux/ """ import datetime import logging diff --git a/homeassistant/components/geo_rss_events/sensor.py b/homeassistant/components/geo_rss_events/sensor.py index b8891cdef0d..3ac973f77a0 100644 --- a/homeassistant/components/geo_rss_events/sensor.py +++ b/homeassistant/components/geo_rss_events/sensor.py @@ -4,9 +4,6 @@ Generic GeoRSS events service. Retrieves current events (typically incidents or alerts) in GeoRSS format, and shows information on events filtered by distance to the HA instance's location and grouped by category. - -For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.geo_rss_events/ """ from datetime import timedelta import logging diff --git a/homeassistant/components/izone/__init__.py b/homeassistant/components/izone/__init__.py index 0e5dcddbc48..1b4d2f19d1c 100644 --- a/homeassistant/components/izone/__init__.py +++ b/homeassistant/components/izone/__init__.py @@ -1,9 +1,4 @@ -""" -Platform for the iZone AC. - -For more details about this component, please refer to the documentation -https://home-assistant.io/integrations/izone/ -""" +"""Platform for the iZone AC.""" import logging import voluptuous as vol diff --git a/homeassistant/components/kodi/notify.py b/homeassistant/components/kodi/notify.py index 6f370ffad98..fae5c856d9d 100644 --- a/homeassistant/components/kodi/notify.py +++ b/homeassistant/components/kodi/notify.py @@ -58,7 +58,7 @@ async def async_get_service(hass, config, discovery_info=None): _LOGGER.warning( "Kodi host name should no longer contain http:// See updated " "definitions here: " - "https://home-assistant.io/components/media_player.kodi/" + "https://home-assistant.io/integrations/media_player.kodi/" ) http_protocol = "https" if encryption else "http" diff --git a/homeassistant/components/lifx_legacy/light.py b/homeassistant/components/lifx_legacy/light.py index 8f767a2f559..7fb0e686b31 100644 --- a/homeassistant/components/lifx_legacy/light.py +++ b/homeassistant/components/lifx_legacy/light.py @@ -3,9 +3,6 @@ Support for the LIFX platform that implements lights. This is a legacy platform, included because the current lifx platform does not yet support Windows. - -For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/light.lifx/ """ import logging diff --git a/homeassistant/components/meraki/device_tracker.py b/homeassistant/components/meraki/device_tracker.py index 1aa1485922e..614c2943530 100644 --- a/homeassistant/components/meraki/device_tracker.py +++ b/homeassistant/components/meraki/device_tracker.py @@ -1,10 +1,4 @@ -""" -Support for the Meraki CMX location service. - -For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/device_tracker.meraki/ - -""" +"""Support for the Meraki CMX location service.""" import json import logging diff --git a/homeassistant/components/mobile_app/config_flow.py b/homeassistant/components/mobile_app/config_flow.py index 6fc4b342298..08fdecf364d 100644 --- a/homeassistant/components/mobile_app/config_flow.py +++ b/homeassistant/components/mobile_app/config_flow.py @@ -18,7 +18,7 @@ class MobileAppFlowHandler(config_entries.ConfigFlow): async def async_step_user(self, user_input=None): """Handle a flow initialized by the user.""" placeholders = { - "apps_url": "https://www.home-assistant.io/components/mobile_app/#apps" + "apps_url": "https://www.home-assistant.io/integrations/mobile_app/#apps" } return self.async_abort( diff --git a/homeassistant/components/mqtt/light/__init__.py b/homeassistant/components/mqtt/light/__init__.py index a72008c059f..511ee6049df 100644 --- a/homeassistant/components/mqtt/light/__init__.py +++ b/homeassistant/components/mqtt/light/__init__.py @@ -1,9 +1,4 @@ -""" -Support for MQTT lights. - -For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/light.mqtt/ -""" +"""Support for MQTT lights.""" import logging import voluptuous as vol diff --git a/homeassistant/components/mqtt/light/schema_basic.py b/homeassistant/components/mqtt/light/schema_basic.py index ff57db7c8c1..041c5e804dc 100644 --- a/homeassistant/components/mqtt/light/schema_basic.py +++ b/homeassistant/components/mqtt/light/schema_basic.py @@ -1,9 +1,4 @@ -""" -Support for MQTT lights. - -For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/light.mqtt/ -""" +"""Support for MQTT lights.""" import logging import voluptuous as vol diff --git a/homeassistant/components/mqtt/light/schema_json.py b/homeassistant/components/mqtt/light/schema_json.py index c4de1edbc3c..373fbc1b3b2 100644 --- a/homeassistant/components/mqtt/light/schema_json.py +++ b/homeassistant/components/mqtt/light/schema_json.py @@ -1,9 +1,4 @@ -""" -Support for MQTT JSON lights. - -For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/light.mqtt_json/ -""" +"""Support for MQTT JSON lights.""" import json import logging diff --git a/homeassistant/components/mqtt/light/schema_template.py b/homeassistant/components/mqtt/light/schema_template.py index dd69a8e87d6..82f0fa3c9d0 100644 --- a/homeassistant/components/mqtt/light/schema_template.py +++ b/homeassistant/components/mqtt/light/schema_template.py @@ -1,9 +1,4 @@ -""" -Support for MQTT Template lights. - -For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/light.mqtt_template/ -""" +"""Support for MQTT Template lights.""" import logging import voluptuous as vol diff --git a/homeassistant/components/mqtt/vacuum/__init__.py b/homeassistant/components/mqtt/vacuum/__init__.py index 84f564e5c7e..d33a23f3a6d 100644 --- a/homeassistant/components/mqtt/vacuum/__init__.py +++ b/homeassistant/components/mqtt/vacuum/__init__.py @@ -1,9 +1,4 @@ -""" -Support for MQTT vacuums. - -For more details about this platform, please refer to the documentation at -https://www.home-assistant.io/components/vacuum.mqtt/ -""" +"""Support for MQTT vacuums.""" import logging import voluptuous as vol diff --git a/homeassistant/components/neato/config_flow.py b/homeassistant/components/neato/config_flow.py index 56fba9047e7..88a2085b339 100644 --- a/homeassistant/components/neato/config_flow.py +++ b/homeassistant/components/neato/config_flow.py @@ -12,7 +12,7 @@ from homeassistant.const import CONF_PASSWORD, CONF_USERNAME # pylint: disable=unused-import from .const import CONF_VENDOR, NEATO_DOMAIN, VALID_VENDORS -DOCS_URL = "https://www.home-assistant.io/components/neato" +DOCS_URL = "https://www.home-assistant.io/integrations/neato" DEFAULT_VENDOR = "neato" _LOGGER = logging.getLogger(__name__) diff --git a/homeassistant/components/nest/binary_sensor.py b/homeassistant/components/nest/binary_sensor.py index 05170a54ed1..1ee500c793c 100644 --- a/homeassistant/components/nest/binary_sensor.py +++ b/homeassistant/components/nest/binary_sensor.py @@ -71,7 +71,7 @@ async def async_setup_entry(hass, entry, async_add_entities): wstr = ( variable + " is no a longer supported " "monitored_conditions. See " - "https://home-assistant.io/components/binary_sensor.nest/ " + "https://home-assistant.io/integrations/binary_sensor.nest/ " "for valid options." ) _LOGGER.error(wstr) diff --git a/homeassistant/components/nest/sensor.py b/homeassistant/components/nest/sensor.py index 6b1a198abbb..f8ae56f838c 100644 --- a/homeassistant/components/nest/sensor.py +++ b/homeassistant/components/nest/sensor.py @@ -90,14 +90,14 @@ async def async_setup_entry(hass, entry, async_add_entities): if variable in DEPRECATED_WEATHER_VARS: wstr = ( "Nest no longer provides weather data like %s. See " - "https://home-assistant.io/components/#weather " + "https://home-assistant.io/integrations/#weather " "for a list of other weather integrations to use." % variable ) else: wstr = ( variable + " is no a longer supported " "monitored_conditions. See " - "https://home-assistant.io/components/" + "https://home-assistant.io/integrations/" "binary_sensor.nest/ for valid options." ) _LOGGER.error(wstr) diff --git a/homeassistant/components/onvif/camera.py b/homeassistant/components/onvif/camera.py index 3f244530dca..58d125bf1f8 100644 --- a/homeassistant/components/onvif/camera.py +++ b/homeassistant/components/onvif/camera.py @@ -1,9 +1,4 @@ -""" -Support for ONVIF Cameras with FFmpeg as decoder. - -For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/camera.onvif/ -""" +"""Support for ONVIF Cameras with FFmpeg as decoder.""" import asyncio import datetime as dt import logging diff --git a/homeassistant/components/pandora/media_player.py b/homeassistant/components/pandora/media_player.py index 07f697a5a46..4b3c25862a1 100644 --- a/homeassistant/components/pandora/media_player.py +++ b/homeassistant/components/pandora/media_player.py @@ -384,6 +384,6 @@ def _pianobar_exists(): _LOGGER.warning( "The Pandora integration depends on the Pianobar client, which " "cannot be found. Please install using instructions at " - "https://home-assistant.io/components/media_player.pandora/" + "https://home-assistant.io/integrations/media_player.pandora/" ) return False diff --git a/homeassistant/components/pencom/switch.py b/homeassistant/components/pencom/switch.py index 36266feaa6e..5cd1f826629 100644 --- a/homeassistant/components/pencom/switch.py +++ b/homeassistant/components/pencom/switch.py @@ -1,8 +1,4 @@ -"""Pencom relay control. - -For more details about this component, please refer to the documentation at -http://home-assistant.io/components/switch.pencom -""" +"""Pencom relay control.""" import logging from pencompy.pencompy import Pencompy diff --git a/homeassistant/components/rejseplanen/sensor.py b/homeassistant/components/rejseplanen/sensor.py index b7d36010714..419600ce562 100644 --- a/homeassistant/components/rejseplanen/sensor.py +++ b/homeassistant/components/rejseplanen/sensor.py @@ -3,9 +3,6 @@ Support for Rejseplanen information from rejseplanen.dk. For more info on the API see: https://help.rejseplanen.dk/hc/en-us/articles/214174465-Rejseplanen-s-API - -For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.rejseplanen/ """ from datetime import datetime, timedelta import logging diff --git a/homeassistant/components/smarthab/__init__.py b/homeassistant/components/smarthab/__init__.py index ef2da4e9a1d..778b5171ae4 100644 --- a/homeassistant/components/smarthab/__init__.py +++ b/homeassistant/components/smarthab/__init__.py @@ -1,9 +1,4 @@ -""" -Support for SmartHab device integration. - -For more details about this component, please refer to the documentation at -https://home-assistant.io/integrations/smarthab/ -""" +"""Support for SmartHab device integration.""" import logging import pysmarthab diff --git a/homeassistant/components/smarthab/cover.py b/homeassistant/components/smarthab/cover.py index 9bcb89b7ab4..af55f2de7f9 100644 --- a/homeassistant/components/smarthab/cover.py +++ b/homeassistant/components/smarthab/cover.py @@ -1,9 +1,4 @@ -""" -Support for SmartHab device integration. - -For more details about this component, please refer to the documentation at -https://home-assistant.io/integrations/smarthab/ -""" +"""Support for SmartHab device integration.""" from datetime import timedelta import logging diff --git a/homeassistant/components/smarthab/light.py b/homeassistant/components/smarthab/light.py index bc6eb31fd04..469d89011b8 100644 --- a/homeassistant/components/smarthab/light.py +++ b/homeassistant/components/smarthab/light.py @@ -1,9 +1,4 @@ -""" -Support for SmartHab device integration. - -For more details about this component, please refer to the documentation at -https://home-assistant.io/integrations/smarthab/ -""" +"""Support for SmartHab device integration.""" from datetime import timedelta import logging diff --git a/homeassistant/components/somfy/__init__.py b/homeassistant/components/somfy/__init__.py index 365c6839300..aa288e13ac7 100644 --- a/homeassistant/components/somfy/__init__.py +++ b/homeassistant/components/somfy/__init__.py @@ -1,9 +1,4 @@ -""" -Support for Somfy hubs. - -For more details about this component, please refer to the documentation at -https://home-assistant.io/integrations/somfy/ -""" +"""Support for Somfy hubs.""" import asyncio from datetime import timedelta import logging diff --git a/homeassistant/components/synology_srm/device_tracker.py b/homeassistant/components/synology_srm/device_tracker.py index 36306efa93e..577a01c5148 100644 --- a/homeassistant/components/synology_srm/device_tracker.py +++ b/homeassistant/components/synology_srm/device_tracker.py @@ -1,8 +1,4 @@ -"""Device tracker for Synology SRM routers. - -For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/device_tracker.synology_srm/ -""" +"""Device tracker for Synology SRM routers.""" import logging import synology_srm diff --git a/homeassistant/components/thermoworks_smoke/sensor.py b/homeassistant/components/thermoworks_smoke/sensor.py index d5af021108a..83a2fd12d24 100644 --- a/homeassistant/components/thermoworks_smoke/sensor.py +++ b/homeassistant/components/thermoworks_smoke/sensor.py @@ -2,9 +2,6 @@ Support for getting the state of a Thermoworks Smoke Thermometer. Requires Smoke Gateway Wifi with an internet connection. - -For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.thermoworks_smoke/ """ import logging diff --git a/homeassistant/components/uk_transport/sensor.py b/homeassistant/components/uk_transport/sensor.py index e3c5440c450..77b1c1a6f11 100644 --- a/homeassistant/components/uk_transport/sensor.py +++ b/homeassistant/components/uk_transport/sensor.py @@ -1,8 +1,4 @@ -"""Support for UK public transport data provided by transportapi.com. - -For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/sensor.uk_transport/ -""" +"""Support for UK public transport data provided by transportapi.com.""" from datetime import datetime, timedelta import logging import re diff --git a/homeassistant/components/volumio/media_player.py b/homeassistant/components/volumio/media_player.py index 369b9c33c0d..90e62c0d951 100644 --- a/homeassistant/components/volumio/media_player.py +++ b/homeassistant/components/volumio/media_player.py @@ -1,9 +1,6 @@ """ Volumio Platform. -For more details about this platform, please refer to the documentation at -https://home-assistant.io/components/media_player.volumio/ - Volumio rest API: https://volumio.github.io/docs/API/REST_API.html """ import asyncio diff --git a/homeassistant/components/zha/core/__init__.py b/homeassistant/components/zha/core/__init__.py index 1873cd7dc55..a416ff2eebe 100644 --- a/homeassistant/components/zha/core/__init__.py +++ b/homeassistant/components/zha/core/__init__.py @@ -1,9 +1,4 @@ -""" -Core module for Zigbee Home Automation. - -For more details about this component, please refer to the documentation at -https://home-assistant.io/integrations/zha/ -""" +"""Core module for Zigbee Home Automation.""" # flake8: noqa from .device import ZHADevice diff --git a/homeassistant/components/zha/core/channels/__init__.py b/homeassistant/components/zha/core/channels/__init__.py index d899f51b487..1210ac9d32c 100644 --- a/homeassistant/components/zha/core/channels/__init__.py +++ b/homeassistant/components/zha/core/channels/__init__.py @@ -1,9 +1,4 @@ -""" -Channels module for Zigbee Home Automation. - -For more details about this component, please refer to the documentation at -https://home-assistant.io/integrations/zha/ -""" +"""Channels module for Zigbee Home Automation.""" import asyncio from concurrent.futures import TimeoutError as Timeout from enum import Enum diff --git a/homeassistant/components/zha/core/channels/closures.py b/homeassistant/components/zha/core/channels/closures.py index 03b1a8450db..0cf6f840070 100644 --- a/homeassistant/components/zha/core/channels/closures.py +++ b/homeassistant/components/zha/core/channels/closures.py @@ -1,9 +1,4 @@ -""" -Closures channels module for Zigbee Home Automation. - -For more details about this component, please refer to the documentation at -https://home-assistant.io/integrations/zha/ -""" +"""Closures channels module for Zigbee Home Automation.""" import logging import zigpy.zcl.clusters.closures as closures diff --git a/homeassistant/components/zha/core/channels/general.py b/homeassistant/components/zha/core/channels/general.py index c1701479a43..111b35e7e58 100644 --- a/homeassistant/components/zha/core/channels/general.py +++ b/homeassistant/components/zha/core/channels/general.py @@ -1,9 +1,4 @@ -""" -General channels module for Zigbee Home Automation. - -For more details about this component, please refer to the documentation at -https://home-assistant.io/integrations/zha/ -""" +"""General channels module for Zigbee Home Automation.""" import logging import zigpy.zcl.clusters.general as general diff --git a/homeassistant/components/zha/core/channels/homeautomation.py b/homeassistant/components/zha/core/channels/homeautomation.py index d9d8f57eaaf..8c2c2e57972 100644 --- a/homeassistant/components/zha/core/channels/homeautomation.py +++ b/homeassistant/components/zha/core/channels/homeautomation.py @@ -1,9 +1,4 @@ -""" -Home automation channels module for Zigbee Home Automation. - -For more details about this component, please refer to the documentation at -https://home-assistant.io/integrations/zha/ -""" +"""Home automation channels module for Zigbee Home Automation.""" import logging from typing import Optional diff --git a/homeassistant/components/zha/core/channels/hvac.py b/homeassistant/components/zha/core/channels/hvac.py index db4745d51c3..b638259b4a1 100644 --- a/homeassistant/components/zha/core/channels/hvac.py +++ b/homeassistant/components/zha/core/channels/hvac.py @@ -1,9 +1,4 @@ -""" -HVAC channels module for Zigbee Home Automation. - -For more details about this component, please refer to the documentation at -https://home-assistant.io/integrations/zha/ -""" +"""HVAC channels module for Zigbee Home Automation.""" import logging from zigpy.exceptions import DeliveryError diff --git a/homeassistant/components/zha/core/channels/lighting.py b/homeassistant/components/zha/core/channels/lighting.py index 272fa28905c..0a1e2048132 100644 --- a/homeassistant/components/zha/core/channels/lighting.py +++ b/homeassistant/components/zha/core/channels/lighting.py @@ -1,9 +1,4 @@ -""" -Lighting channels module for Zigbee Home Automation. - -For more details about this component, please refer to the documentation at -https://home-assistant.io/integrations/zha/ -""" +"""Lighting channels module for Zigbee Home Automation.""" import logging import zigpy.zcl.clusters.lighting as lighting diff --git a/homeassistant/components/zha/core/channels/lightlink.py b/homeassistant/components/zha/core/channels/lightlink.py index 7cd2134988d..5d0ac199185 100644 --- a/homeassistant/components/zha/core/channels/lightlink.py +++ b/homeassistant/components/zha/core/channels/lightlink.py @@ -1,9 +1,4 @@ -""" -Lightlink channels module for Zigbee Home Automation. - -For more details about this component, please refer to the documentation at -https://home-assistant.io/integrations/zha/ -""" +"""Lightlink channels module for Zigbee Home Automation.""" import logging import zigpy.zcl.clusters.lightlink as lightlink diff --git a/homeassistant/components/zha/core/channels/manufacturerspecific.py b/homeassistant/components/zha/core/channels/manufacturerspecific.py index 39f45f6c4a2..e3d1e67439f 100644 --- a/homeassistant/components/zha/core/channels/manufacturerspecific.py +++ b/homeassistant/components/zha/core/channels/manufacturerspecific.py @@ -1,9 +1,4 @@ -""" -Manufacturer specific channels module for Zigbee Home Automation. - -For more details about this component, please refer to the documentation at -https://home-assistant.io/integrations/zha/ -""" +"""Manufacturer specific channels module for Zigbee Home Automation.""" import logging from homeassistant.core import callback diff --git a/homeassistant/components/zha/core/channels/measurement.py b/homeassistant/components/zha/core/channels/measurement.py index 369ecb69aa1..dfb83224505 100644 --- a/homeassistant/components/zha/core/channels/measurement.py +++ b/homeassistant/components/zha/core/channels/measurement.py @@ -1,9 +1,4 @@ -""" -Measurement channels module for Zigbee Home Automation. - -For more details about this component, please refer to the documentation at -https://home-assistant.io/integrations/zha/ -""" +"""Measurement channels module for Zigbee Home Automation.""" import logging import zigpy.zcl.clusters.measurement as measurement diff --git a/homeassistant/components/zha/core/channels/protocol.py b/homeassistant/components/zha/core/channels/protocol.py index aa463392e55..20867553121 100644 --- a/homeassistant/components/zha/core/channels/protocol.py +++ b/homeassistant/components/zha/core/channels/protocol.py @@ -1,9 +1,4 @@ -""" -Protocol channels module for Zigbee Home Automation. - -For more details about this component, please refer to the documentation at -https://home-assistant.io/integrations/zha/ -""" +"""Protocol channels module for Zigbee Home Automation.""" import logging import zigpy.zcl.clusters.protocol as protocol diff --git a/homeassistant/components/zha/core/channels/security.py b/homeassistant/components/zha/core/channels/security.py index 781738fc048..a529ff69d32 100644 --- a/homeassistant/components/zha/core/channels/security.py +++ b/homeassistant/components/zha/core/channels/security.py @@ -1,9 +1,4 @@ -""" -Security channels module for Zigbee Home Automation. - -For more details about this component, please refer to the documentation at -https://home-assistant.io/integrations/zha/ -""" +"""Security channels module for Zigbee Home Automation.""" import logging from zigpy.exceptions import DeliveryError diff --git a/homeassistant/components/zha/core/channels/smartenergy.py b/homeassistant/components/zha/core/channels/smartenergy.py index c7de2943691..08feb328603 100644 --- a/homeassistant/components/zha/core/channels/smartenergy.py +++ b/homeassistant/components/zha/core/channels/smartenergy.py @@ -1,9 +1,4 @@ -""" -Smart energy channels module for Zigbee Home Automation. - -For more details about this component, please refer to the documentation at -https://home-assistant.io/integrations/zha/ -""" +"""Smart energy channels module for Zigbee Home Automation.""" import logging import zigpy.zcl.clusters.smartenergy as smartenergy diff --git a/homeassistant/components/zha/core/device.py b/homeassistant/components/zha/core/device.py index 2e7c48c639f..ffa264dde63 100644 --- a/homeassistant/components/zha/core/device.py +++ b/homeassistant/components/zha/core/device.py @@ -1,9 +1,4 @@ -""" -Device for Zigbee Home Automation. - -For more details about this component, please refer to the documentation at -https://home-assistant.io/integrations/zha/ -""" +"""Device for Zigbee Home Automation.""" import asyncio from datetime import timedelta from enum import Enum diff --git a/homeassistant/components/zha/core/discovery.py b/homeassistant/components/zha/core/discovery.py index d128ed274c0..c8514e2937d 100644 --- a/homeassistant/components/zha/core/discovery.py +++ b/homeassistant/components/zha/core/discovery.py @@ -1,9 +1,4 @@ -""" -Device discovery functions for Zigbee Home Automation. - -For more details about this component, please refer to the documentation at -https://home-assistant.io/integrations/zha/ -""" +"""Device discovery functions for Zigbee Home Automation.""" import logging diff --git a/homeassistant/components/zha/core/gateway.py b/homeassistant/components/zha/core/gateway.py index 33faaa334cb..8a8f57764a6 100644 --- a/homeassistant/components/zha/core/gateway.py +++ b/homeassistant/components/zha/core/gateway.py @@ -1,9 +1,4 @@ -""" -Virtual gateway for Zigbee Home Automation. - -For more details about this component, please refer to the documentation at -https://home-assistant.io/integrations/zha/ -""" +"""Virtual gateway for Zigbee Home Automation.""" import asyncio import collections diff --git a/homeassistant/components/zha/core/group.py b/homeassistant/components/zha/core/group.py index 92ce1f75360..ca2cc0ff1d3 100644 --- a/homeassistant/components/zha/core/group.py +++ b/homeassistant/components/zha/core/group.py @@ -1,9 +1,4 @@ -""" -Group for Zigbee Home Automation. - -For more details about this component, please refer to the documentation at -https://home-assistant.io/integrations/zha/ -""" +"""Group for Zigbee Home Automation.""" import asyncio import logging diff --git a/homeassistant/components/zha/core/helpers.py b/homeassistant/components/zha/core/helpers.py index e3ff446ba98..c0008b055db 100644 --- a/homeassistant/components/zha/core/helpers.py +++ b/homeassistant/components/zha/core/helpers.py @@ -1,9 +1,4 @@ -""" -Helpers for Zigbee Home Automation. - -For more details about this component, please refer to the documentation at -https://home-assistant.io/integrations/zha/ -""" +"""Helpers for Zigbee Home Automation.""" import collections import logging diff --git a/homeassistant/components/zha/core/patches.py b/homeassistant/components/zha/core/patches.py index a4e84e83105..3d8c84e9bf3 100644 --- a/homeassistant/components/zha/core/patches.py +++ b/homeassistant/components/zha/core/patches.py @@ -1,9 +1,4 @@ -""" -Patch functions for Zigbee Home Automation. - -For more details about this component, please refer to the documentation at -https://home-assistant.io/integrations/zha/ -""" +"""Patch functions for Zigbee Home Automation.""" def apply_application_controller_patch(zha_gateway): diff --git a/homeassistant/components/zha/core/registries.py b/homeassistant/components/zha/core/registries.py index 4f5c6fc5c6b..bc788b39ee7 100644 --- a/homeassistant/components/zha/core/registries.py +++ b/homeassistant/components/zha/core/registries.py @@ -1,9 +1,4 @@ -""" -Mapping registries for Zigbee Home Automation. - -For more details about this component, please refer to the documentation at -https://home-assistant.io/integrations/zha/ -""" +"""Mapping registries for Zigbee Home Automation.""" import collections from typing import Callable, Set, Union