Update file headers and outdated documentation links (#32022)

* Update documentation links

* Update file headers v2

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

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
 

homeassistant/components/dyson/fan.py

@@ -1,8 +1,4 @@
-"""Support for Dyson Pure Cool link fan.
+"""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/
-"""
 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,
+        DYSON_DOMAIN, SERVICE_SET_AUTO_MODE, service_handle, schema=SET_AUTO_MODE_SCHEMA
-        SERVICE_SET_AUTO_MODE,
-        service_handle,
-        schema=SET_AUTO_MODE_SCHEMA,
     )
     if has_purecool_devices:
         hass.services.register(

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

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
 

homeassistant/components/environment_canada/camera.py

@@ -1,9 +1,4 @@
-"""
+"""Support for the Environment Canada radar imagery."""
-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/
-"""
 import datetime
 import logging
 

homeassistant/components/environment_canada/sensor.py

@@ -1,9 +1,4 @@
-"""
+"""Support for the Environment Canada weather service."""
-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/
-"""
 from datetime import datetime, timedelta
 import logging
 import re

homeassistant/components/environment_canada/weather.py

@@ -1,9 +1,4 @@
-"""
+"""Platform for retrieving meteorological data from Environment Canada."""
-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/
-"""
 import datetime
 import logging
 import re

homeassistant/components/fail2ban/sensor.py

@@ -1,10 +1,4 @@
-"""
+"""Support for displaying IPs banned by fail2ban."""
-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/
-
-"""
 from datetime import timedelta
 import logging
 import os

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

homeassistant/components/flexit/climate.py

@@ -1,16 +1,4 @@
-"""
+"""Platform for Flexit AC units with CI66 Modbus adapter."""
-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/
-"""
 import logging
 from typing import List
 

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

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

homeassistant/components/izone/__init__.py

@@ -1,9 +1,4 @@
-"""
+"""Platform for the iZone AC."""
-Platform for the iZone AC.
-
-For more details about this component, please refer to the documentation
-https://home-assistant.io/integrations/izone/
-"""
 import logging
 
 import voluptuous as vol

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"

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
 

homeassistant/components/meraki/device_tracker.py

@@ -1,10 +1,4 @@
-"""
+"""Support for the Meraki CMX location service."""
-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/
-
-"""
 import json
 import logging
 

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(

homeassistant/components/mqtt/light/__init__.py

@@ -1,9 +1,4 @@
-"""
+"""Support for MQTT lights."""
-Support for MQTT lights.
-
-For more details about this platform, please refer to the documentation at
-https://home-assistant.io/components/light.mqtt/
-"""
 import logging
 
 import voluptuous as vol

homeassistant/components/mqtt/light/schema_basic.py

@@ -1,9 +1,4 @@
-"""
+"""Support for MQTT lights."""
-Support for MQTT lights.
-
-For more details about this platform, please refer to the documentation at
-https://home-assistant.io/components/light.mqtt/
-"""
 import logging
 
 import voluptuous as vol

homeassistant/components/mqtt/light/schema_json.py

@@ -1,9 +1,4 @@
-"""
+"""Support for MQTT JSON lights."""
-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/
-"""
 import json
 import logging
 

homeassistant/components/mqtt/light/schema_template.py

@@ -1,9 +1,4 @@
-"""
+"""Support for MQTT Template lights."""
-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/
-"""
 import logging
 
 import voluptuous as vol

homeassistant/components/mqtt/vacuum/__init__.py

@@ -1,9 +1,4 @@
-"""
+"""Support for MQTT vacuums."""
-Support for MQTT vacuums.
-
-For more details about this platform, please refer to the documentation at
-https://www.home-assistant.io/components/vacuum.mqtt/
-"""
 import logging
 
 import voluptuous as vol

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__)

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)

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)

homeassistant/components/onvif/camera.py

@@ -1,9 +1,4 @@
-"""
+"""Support for ONVIF Cameras with FFmpeg as decoder."""
-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/
-"""
 import asyncio
 import datetime as dt
 import logging

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

homeassistant/components/pencom/switch.py

@@ -1,8 +1,4 @@
-"""Pencom relay control.
+"""Pencom relay control."""
-
-For more details about this component, please refer to the documentation at
-http://home-assistant.io/components/switch.pencom
-"""
 import logging
 
 from pencompy.pencompy import Pencompy

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

homeassistant/components/smarthab/__init__.py

@@ -1,9 +1,4 @@
-"""
+"""Support for SmartHab device integration."""
-Support for SmartHab device integration.
-
-For more details about this component, please refer to the documentation at
-https://home-assistant.io/integrations/smarthab/
-"""
 import logging
 
 import pysmarthab

homeassistant/components/smarthab/cover.py

@@ -1,9 +1,4 @@
-"""
+"""Support for SmartHab device integration."""
-Support for SmartHab device integration.
-
-For more details about this component, please refer to the documentation at
-https://home-assistant.io/integrations/smarthab/
-"""
 from datetime import timedelta
 import logging
 

homeassistant/components/smarthab/light.py

@@ -1,9 +1,4 @@
-"""
+"""Support for SmartHab device integration."""
-Support for SmartHab device integration.
-
-For more details about this component, please refer to the documentation at
-https://home-assistant.io/integrations/smarthab/
-"""
 from datetime import timedelta
 import logging
 

homeassistant/components/somfy/__init__.py

@@ -1,9 +1,4 @@
-"""
+"""Support for Somfy hubs."""
-Support for Somfy hubs.
-
-For more details about this component, please refer to the documentation at
-https://home-assistant.io/integrations/somfy/
-"""
 import asyncio
 from datetime import timedelta
 import logging

homeassistant/components/synology_srm/device_tracker.py

@@ -1,8 +1,4 @@
-"""Device tracker for Synology SRM routers.
+"""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/
-"""
 import logging
 
 import synology_srm

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
 

homeassistant/components/uk_transport/sensor.py

@@ -1,8 +1,4 @@
-"""Support for UK public transport data provided by transportapi.com.
+"""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/
-"""
 from datetime import datetime, timedelta
 import logging
 import re

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

homeassistant/components/zha/core/__init__.py

@@ -1,9 +1,4 @@
-"""
+"""Core module for Zigbee Home Automation."""
-Core module for Zigbee Home Automation.
-
-For more details about this component, please refer to the documentation at
-https://home-assistant.io/integrations/zha/
-"""
 
 # flake8: noqa
 from .device import ZHADevice

homeassistant/components/zha/core/channels/__init__.py

@@ -1,9 +1,4 @@
-"""
+"""Channels module for Zigbee 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/
-"""
 import asyncio
 from concurrent.futures import TimeoutError as Timeout
 from enum import Enum

homeassistant/components/zha/core/channels/closures.py

@@ -1,9 +1,4 @@
-"""
+"""Closures channels module for Zigbee Home Automation."""
-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/
-"""
 import logging
 
 import zigpy.zcl.clusters.closures as closures

homeassistant/components/zha/core/channels/general.py

@@ -1,9 +1,4 @@
-"""
+"""General channels module for Zigbee Home Automation."""
-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/
-"""
 import logging
 
 import zigpy.zcl.clusters.general as general

homeassistant/components/zha/core/channels/homeautomation.py

@@ -1,9 +1,4 @@
-"""
+"""Home automation channels module for Zigbee Home Automation."""
-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/
-"""
 import logging
 from typing import Optional
 

homeassistant/components/zha/core/channels/hvac.py

@@ -1,9 +1,4 @@
-"""
+"""HVAC channels module for Zigbee Home Automation."""
-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/
-"""
 import logging
 
 from zigpy.exceptions import DeliveryError

homeassistant/components/zha/core/channels/lighting.py

@@ -1,9 +1,4 @@
-"""
+"""Lighting channels module for Zigbee Home Automation."""
-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/
-"""
 import logging
 
 import zigpy.zcl.clusters.lighting as lighting

homeassistant/components/zha/core/channels/lightlink.py

@@ -1,9 +1,4 @@
-"""
+"""Lightlink channels module for Zigbee Home Automation."""
-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/
-"""
 import logging
 
 import zigpy.zcl.clusters.lightlink as lightlink

homeassistant/components/zha/core/channels/manufacturerspecific.py

@@ -1,9 +1,4 @@
-"""
+"""Manufacturer specific channels module for Zigbee Home Automation."""
-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/
-"""
 import logging
 
 from homeassistant.core import callback

homeassistant/components/zha/core/channels/measurement.py

@@ -1,9 +1,4 @@
-"""
+"""Measurement channels module for Zigbee Home Automation."""
-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/
-"""
 import logging
 
 import zigpy.zcl.clusters.measurement as measurement

homeassistant/components/zha/core/channels/protocol.py

@@ -1,9 +1,4 @@
-"""
+"""Protocol channels module for Zigbee Home Automation."""
-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/
-"""
 import logging
 
 import zigpy.zcl.clusters.protocol as protocol

homeassistant/components/zha/core/channels/security.py

@@ -1,9 +1,4 @@
-"""
+"""Security channels module for Zigbee Home Automation."""
-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/
-"""
 import logging
 
 from zigpy.exceptions import DeliveryError

homeassistant/components/zha/core/channels/smartenergy.py

@@ -1,9 +1,4 @@
-"""
+"""Smart energy channels module for Zigbee Home Automation."""
-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/
-"""
 import logging
 
 import zigpy.zcl.clusters.smartenergy as smartenergy

homeassistant/components/zha/core/device.py

@@ -1,9 +1,4 @@
-"""
+"""Device for Zigbee Home Automation."""
-Device for Zigbee Home Automation.
-
-For more details about this component, please refer to the documentation at
-https://home-assistant.io/integrations/zha/
-"""
 import asyncio
 from datetime import timedelta
 from enum import Enum

homeassistant/components/zha/core/discovery.py

@@ -1,9 +1,4 @@
-"""
+"""Device discovery functions for Zigbee Home Automation."""
-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/
-"""
 
 import logging
 

homeassistant/components/zha/core/gateway.py

@@ -1,9 +1,4 @@
-"""
+"""Virtual gateway for Zigbee Home Automation."""
-Virtual gateway for Zigbee Home Automation.
-
-For more details about this component, please refer to the documentation at
-https://home-assistant.io/integrations/zha/
-"""
 
 import asyncio
 import collections

homeassistant/components/zha/core/group.py

@@ -1,9 +1,4 @@
-"""
+"""Group for Zigbee Home Automation."""
-Group for Zigbee Home Automation.
-
-For more details about this component, please refer to the documentation at
-https://home-assistant.io/integrations/zha/
-"""
 import asyncio
 import logging
 

homeassistant/components/zha/core/helpers.py

@@ -1,9 +1,4 @@
-"""
+"""Helpers for Zigbee Home Automation."""
-Helpers for Zigbee Home Automation.
-
-For more details about this component, please refer to the documentation at
-https://home-assistant.io/integrations/zha/
-"""
 import collections
 import logging
 

homeassistant/components/zha/core/patches.py

@@ -1,9 +1,4 @@
-"""
+"""Patch functions for Zigbee Home Automation."""
-Patch functions for Zigbee Home Automation.
-
-For more details about this component, please refer to the documentation at
-https://home-assistant.io/integrations/zha/
-"""
 
 
 def apply_application_controller_patch(zha_gateway):

homeassistant/components/zha/core/registries.py

@@ -1,9 +1,4 @@
-"""
+"""Mapping registries for Zigbee Home Automation."""
-Mapping registries for Zigbee Home Automation.
-
-For more details about this component, please refer to the documentation at
-https://home-assistant.io/integrations/zha/
-"""
 import collections
 from typing import Callable, Set, Union