Update file headers and outdated documentation links (#32022)

* Update documentation links

* Update file headers v2
pull/32039/head
springstan 2020-02-21 00:29:46 +01:00 committed by GitHub
parent 51b5796916
commit 1ee7c483a7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
58 changed files with 49 additions and 295 deletions

View File

@ -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

View File

@ -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

View File

@ -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(

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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"

View File

@ -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

View File

@ -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

View File

@ -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(

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

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

View File

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

View File

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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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):

View File

@ -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