From 4a3c0cd0a874dab0f971435eb9d6345e35b2437a Mon Sep 17 00:00:00 2001 From: epenet <6771947+epenet@users.noreply.github.com> Date: Fri, 3 Mar 2023 11:26:13 +0100 Subject: [PATCH] Adjust docstrings for ruff D404 (#89077) --- homeassistant/components/__init__.py | 2 +- homeassistant/components/actiontec/device_tracker.py | 2 +- homeassistant/components/alexa/errors.py | 2 +- homeassistant/components/arris_tg2492lg/device_tracker.py | 2 +- homeassistant/components/aruba/device_tracker.py | 2 +- homeassistant/components/bbox/device_tracker.py | 2 +- homeassistant/components/bt_home_hub_5/device_tracker.py | 2 +- homeassistant/components/bt_smarthub/device_tracker.py | 2 +- homeassistant/components/cisco_ios/device_tracker.py | 2 +- .../components/cisco_mobility_express/device_tracker.py | 2 +- homeassistant/components/ddwrt/device_tracker.py | 2 +- homeassistant/components/demo/geo_location.py | 2 +- homeassistant/components/forked_daapd/media_player.py | 2 +- homeassistant/components/fortios/device_tracker.py | 2 +- homeassistant/components/foscam/camera.py | 2 +- homeassistant/components/fritz/device_tracker.py | 2 +- homeassistant/components/fritzbox_callmonitor/base.py | 2 +- homeassistant/components/gdacs/geo_location.py | 2 +- homeassistant/components/gdacs/sensor.py | 2 +- homeassistant/components/geo_json_events/geo_location.py | 2 +- homeassistant/components/geonetnz_quakes/geo_location.py | 2 +- homeassistant/components/geonetnz_quakes/sensor.py | 2 +- homeassistant/components/geonetnz_volcano/sensor.py | 2 +- homeassistant/components/group/binary_sensor.py | 2 +- homeassistant/components/group/cover.py | 2 +- homeassistant/components/group/fan.py | 2 +- homeassistant/components/group/light.py | 2 +- homeassistant/components/group/lock.py | 2 +- homeassistant/components/group/media_player.py | 2 +- homeassistant/components/group/sensor.py | 2 +- homeassistant/components/group/switch.py | 2 +- homeassistant/components/hitron_coda/device_tracker.py | 2 +- homeassistant/components/ign_sismologia/geo_location.py | 2 +- homeassistant/components/intellifire/fan.py | 2 +- homeassistant/components/intellifire/light.py | 2 +- homeassistant/components/linksys_smart/device_tracker.py | 2 +- homeassistant/components/lirc/__init__.py | 2 +- homeassistant/components/luci/device_tracker.py | 2 +- homeassistant/components/mqtt/alarm_control_panel.py | 2 +- homeassistant/components/nmap_tracker/__init__.py | 2 +- .../components/nsw_rural_fire_service_feed/geo_location.py | 2 +- homeassistant/components/opnsense/device_tracker.py | 2 +- homeassistant/components/qld_bushfire/geo_location.py | 2 +- homeassistant/components/quantum_gateway/device_tracker.py | 2 +- homeassistant/components/rainmachine/binary_sensor.py | 2 +- homeassistant/components/rainmachine/sensor.py | 2 +- homeassistant/components/rainmachine/switch.py | 2 +- homeassistant/components/reolink/binary_sensor.py | 2 +- homeassistant/components/reolink/camera.py | 2 +- homeassistant/components/reolink/host.py | 2 +- homeassistant/components/reolink/number.py | 2 +- homeassistant/components/ring/binary_sensor.py | 2 +- homeassistant/components/ring/camera.py | 2 +- homeassistant/components/ring/light.py | 2 +- homeassistant/components/ring/sensor.py | 2 +- homeassistant/components/ring/siren.py | 2 +- homeassistant/components/ring/switch.py | 2 +- homeassistant/components/sky_hub/device_tracker.py | 2 +- homeassistant/components/stookalert/binary_sensor.py | 2 +- homeassistant/components/stookwijzer/sensor.py | 2 +- homeassistant/components/swisscom/device_tracker.py | 2 +- homeassistant/components/synology_srm/device_tracker.py | 2 +- homeassistant/components/tado/device_tracker.py | 2 +- homeassistant/components/thomson/device_tracker.py | 2 +- homeassistant/components/tomato/device_tracker.py | 2 +- homeassistant/components/travisci/sensor.py | 2 +- homeassistant/components/ubus/device_tracker.py | 2 +- homeassistant/components/unifi_direct/device_tracker.py | 2 +- homeassistant/components/unifiprotect/binary_sensor.py | 2 +- homeassistant/components/unifiprotect/light.py | 2 +- homeassistant/components/unifiprotect/number.py | 2 +- homeassistant/components/unifiprotect/select.py | 2 +- homeassistant/components/unifiprotect/sensor.py | 2 +- homeassistant/components/unifiprotect/switch.py | 2 +- homeassistant/components/upc_connect/device_tracker.py | 2 +- homeassistant/components/usgs_earthquakes_feed/geo_location.py | 2 +- homeassistant/components/xiaomi/camera.py | 2 +- homeassistant/components/xiaomi/device_tracker.py | 2 +- homeassistant/components/xiaomi_miio/device_tracker.py | 2 +- 79 files changed, 79 insertions(+), 79 deletions(-) diff --git a/homeassistant/components/__init__.py b/homeassistant/components/__init__.py index d0e631fb04c..690b38b4871 100644 --- a/homeassistant/components/__init__.py +++ b/homeassistant/components/__init__.py @@ -1,4 +1,4 @@ -"""This package contains components that can be plugged into Home Assistant. +"""Contains components that can be plugged into Home Assistant. Component design guidelines: - Each component defines a constant DOMAIN that is equal to its filename. diff --git a/homeassistant/components/actiontec/device_tracker.py b/homeassistant/components/actiontec/device_tracker.py index 9c18e2ba907..5397fed5e1d 100644 --- a/homeassistant/components/actiontec/device_tracker.py +++ b/homeassistant/components/actiontec/device_tracker.py @@ -40,7 +40,7 @@ def get_scanner( class ActiontecDeviceScanner(DeviceScanner): - """This class queries an actiontec router for connected devices.""" + """Class which queries an actiontec router for connected devices.""" def __init__(self, config: ConfigType) -> None: """Initialize the scanner.""" diff --git a/homeassistant/components/alexa/errors.py b/homeassistant/components/alexa/errors.py index 5f0de6f7467..7f4b41b9ec7 100644 --- a/homeassistant/components/alexa/errors.py +++ b/homeassistant/components/alexa/errors.py @@ -9,7 +9,7 @@ from .const import API_TEMP_UNITS class UnsupportedProperty(HomeAssistantError): - """This entity does not support the requested Smart Home API property.""" + """Does not support the requested Smart Home API property.""" class NoTokenAvailable(HomeAssistantError): diff --git a/homeassistant/components/arris_tg2492lg/device_tracker.py b/homeassistant/components/arris_tg2492lg/device_tracker.py index b456aa3f703..48b8d9f13c4 100644 --- a/homeassistant/components/arris_tg2492lg/device_tracker.py +++ b/homeassistant/components/arris_tg2492lg/device_tracker.py @@ -33,7 +33,7 @@ def get_scanner(hass: HomeAssistant, config: ConfigType) -> ArrisDeviceScanner: class ArrisDeviceScanner(DeviceScanner): - """This class queries a Arris TG2492LG router for connected devices.""" + """Class which queries a Arris TG2492LG router for connected devices.""" def __init__(self, connect_box: ConnectBox) -> None: """Initialize the scanner.""" diff --git a/homeassistant/components/aruba/device_tracker.py b/homeassistant/components/aruba/device_tracker.py index d0794553b42..7b8c547fd53 100644 --- a/homeassistant/components/aruba/device_tracker.py +++ b/homeassistant/components/aruba/device_tracker.py @@ -42,7 +42,7 @@ def get_scanner(hass: HomeAssistant, config: ConfigType) -> ArubaDeviceScanner | class ArubaDeviceScanner(DeviceScanner): - """This class queries a Aruba Access Point for connected devices.""" + """Class which queries a Aruba Access Point for connected devices.""" def __init__(self, config): """Initialize the scanner.""" diff --git a/homeassistant/components/bbox/device_tracker.py b/homeassistant/components/bbox/device_tracker.py index a9b0312673b..9c83aaa1734 100644 --- a/homeassistant/components/bbox/device_tracker.py +++ b/homeassistant/components/bbox/device_tracker.py @@ -42,7 +42,7 @@ Device = namedtuple("Device", ["mac", "name", "ip", "last_update"]) class BboxDeviceScanner(DeviceScanner): - """This class scans for devices connected to the bbox.""" + """Scanner for devices connected to the bbox.""" def __init__(self, config): """Get host from config.""" diff --git a/homeassistant/components/bt_home_hub_5/device_tracker.py b/homeassistant/components/bt_home_hub_5/device_tracker.py index 4d89c851245..0ffa3bc699b 100644 --- a/homeassistant/components/bt_home_hub_5/device_tracker.py +++ b/homeassistant/components/bt_home_hub_5/device_tracker.py @@ -35,7 +35,7 @@ def get_scanner( class BTHomeHub5DeviceScanner(DeviceScanner): - """This class queries a BT Home Hub 5.""" + """Class which queries a BT Home Hub 5.""" def __init__(self, config): """Initialise the scanner.""" diff --git a/homeassistant/components/bt_smarthub/device_tracker.py b/homeassistant/components/bt_smarthub/device_tracker.py index 48475bbeac9..65aa1bd6a61 100644 --- a/homeassistant/components/bt_smarthub/device_tracker.py +++ b/homeassistant/components/bt_smarthub/device_tracker.py @@ -54,7 +54,7 @@ _Device = namedtuple("_Device", ["ip_address", "mac", "host", "status", "name"]) class BTSmartHubScanner(DeviceScanner): - """This class queries a BT Smart Hub.""" + """Class which queries a BT Smart Hub.""" def __init__(self, smarthub_client): """Initialise the scanner.""" diff --git a/homeassistant/components/cisco_ios/device_tracker.py b/homeassistant/components/cisco_ios/device_tracker.py index 508b2b2d8b3..1424d41006d 100644 --- a/homeassistant/components/cisco_ios/device_tracker.py +++ b/homeassistant/components/cisco_ios/device_tracker.py @@ -39,7 +39,7 @@ def get_scanner(hass: HomeAssistant, config: ConfigType) -> CiscoDeviceScanner | class CiscoDeviceScanner(DeviceScanner): - """This class queries a wireless router running Cisco IOS firmware.""" + """Class which queries a wireless router running Cisco IOS firmware.""" def __init__(self, config): """Initialize the scanner.""" diff --git a/homeassistant/components/cisco_mobility_express/device_tracker.py b/homeassistant/components/cisco_mobility_express/device_tracker.py index 9ce98ec4fe8..a5ca469d101 100644 --- a/homeassistant/components/cisco_mobility_express/device_tracker.py +++ b/homeassistant/components/cisco_mobility_express/device_tracker.py @@ -56,7 +56,7 @@ def get_scanner(hass: HomeAssistant, config: ConfigType) -> CiscoMEDeviceScanner class CiscoMEDeviceScanner(DeviceScanner): - """This class scans for devices associated to a Cisco ME controller.""" + """Scanner for devices associated to a Cisco ME controller.""" def __init__(self, controller): """Initialize the scanner.""" diff --git a/homeassistant/components/ddwrt/device_tracker.py b/homeassistant/components/ddwrt/device_tracker.py index ba34ec48e0f..7874786adba 100644 --- a/homeassistant/components/ddwrt/device_tracker.py +++ b/homeassistant/components/ddwrt/device_tracker.py @@ -55,7 +55,7 @@ def get_scanner(hass: HomeAssistant, config: ConfigType) -> DdWrtDeviceScanner | class DdWrtDeviceScanner(DeviceScanner): - """This class queries a wireless router running DD-WRT firmware.""" + """Class which queries a wireless router running DD-WRT firmware.""" def __init__(self, config): """Initialize the DD-WRT scanner.""" diff --git a/homeassistant/components/demo/geo_location.py b/homeassistant/components/demo/geo_location.py index cc29205b720..2af7437e0f6 100644 --- a/homeassistant/components/demo/geo_location.py +++ b/homeassistant/components/demo/geo_location.py @@ -110,7 +110,7 @@ class DemoManager: class DemoGeolocationEvent(GeolocationEvent): - """This represents a demo geolocation event.""" + """Represents a demo geolocation event.""" _attr_should_poll = False diff --git a/homeassistant/components/forked_daapd/media_player.py b/homeassistant/components/forked_daapd/media_player.py index d42c72b65d1..ca7e0cce27c 100644 --- a/homeassistant/components/forked_daapd/media_player.py +++ b/homeassistant/components/forked_daapd/media_player.py @@ -1,4 +1,4 @@ -"""This library brings support for forked_daapd to Home Assistant.""" +"""Support forked_daapd media player.""" from __future__ import annotations import asyncio diff --git a/homeassistant/components/fortios/device_tracker.py b/homeassistant/components/fortios/device_tracker.py index 65f63829c05..95a418ae40f 100644 --- a/homeassistant/components/fortios/device_tracker.py +++ b/homeassistant/components/fortios/device_tracker.py @@ -67,7 +67,7 @@ def get_scanner(hass: HomeAssistant, config: ConfigType) -> FortiOSDeviceScanner class FortiOSDeviceScanner(DeviceScanner): - """This class queries a FortiOS unit for connected devices.""" + """Class which queries a FortiOS unit for connected devices.""" def __init__(self, fgt) -> None: """Initialize the scanner.""" diff --git a/homeassistant/components/foscam/camera.py b/homeassistant/components/foscam/camera.py index fe11b056880..ae28fd8d111 100644 --- a/homeassistant/components/foscam/camera.py +++ b/homeassistant/components/foscam/camera.py @@ -1,4 +1,4 @@ -"""This component provides basic support for Foscam IP cameras.""" +"""Component providing basic support for Foscam IP cameras.""" from __future__ import annotations import asyncio diff --git a/homeassistant/components/fritz/device_tracker.py b/homeassistant/components/fritz/device_tracker.py index 212710a638c..e32ee152796 100644 --- a/homeassistant/components/fritz/device_tracker.py +++ b/homeassistant/components/fritz/device_tracker.py @@ -68,7 +68,7 @@ def _async_add_entities( class FritzBoxTracker(FritzDeviceBase, ScannerEntity): - """This class queries a FRITZ!Box device.""" + """Class which queries a FRITZ!Box device.""" def __init__(self, avm_wrapper: AvmWrapper, device: FritzDevice) -> None: """Initialize a FRITZ!Box device.""" diff --git a/homeassistant/components/fritzbox_callmonitor/base.py b/homeassistant/components/fritzbox_callmonitor/base.py index 386e60ba199..df19bca7b13 100644 --- a/homeassistant/components/fritzbox_callmonitor/base.py +++ b/homeassistant/components/fritzbox_callmonitor/base.py @@ -19,7 +19,7 @@ MIN_TIME_PHONEBOOK_UPDATE = timedelta(hours=6) class FritzBoxPhonebook: - """This connects to a FritzBox router and downloads its phone book.""" + """Connects to a FritzBox router and downloads its phone book.""" fph: FritzPhonebook phonebook_dict: dict[str, list[str]] diff --git a/homeassistant/components/gdacs/geo_location.py b/homeassistant/components/gdacs/geo_location.py index 06ab1aa0837..1d3dabc464c 100644 --- a/homeassistant/components/gdacs/geo_location.py +++ b/homeassistant/components/gdacs/geo_location.py @@ -77,7 +77,7 @@ async def async_setup_entry( class GdacsEvent(GeolocationEvent): - """This represents an external event with GDACS feed data.""" + """Represents an external event with GDACS feed data.""" _attr_should_poll = False _attr_source = SOURCE diff --git a/homeassistant/components/gdacs/sensor.py b/homeassistant/components/gdacs/sensor.py index 531eb05dcf9..6563e26368a 100644 --- a/homeassistant/components/gdacs/sensor.py +++ b/homeassistant/components/gdacs/sensor.py @@ -39,7 +39,7 @@ async def async_setup_entry( class GdacsSensor(SensorEntity): - """This is a status sensor for the GDACS integration.""" + """Status sensor for the GDACS integration.""" _attr_should_poll = False diff --git a/homeassistant/components/geo_json_events/geo_location.py b/homeassistant/components/geo_json_events/geo_location.py index 166da1184c6..74951bc3a97 100644 --- a/homeassistant/components/geo_json_events/geo_location.py +++ b/homeassistant/components/geo_json_events/geo_location.py @@ -142,7 +142,7 @@ class GeoJsonFeedEntityManager: class GeoJsonLocationEvent(GeolocationEvent): - """This represents an external event with GeoJSON data.""" + """Represents an external event with GeoJSON data.""" _attr_should_poll = False _attr_source = SOURCE diff --git a/homeassistant/components/geonetnz_quakes/geo_location.py b/homeassistant/components/geonetnz_quakes/geo_location.py index 411a0375461..6fa84f590f1 100644 --- a/homeassistant/components/geonetnz_quakes/geo_location.py +++ b/homeassistant/components/geonetnz_quakes/geo_location.py @@ -65,7 +65,7 @@ async def async_setup_entry( class GeonetnzQuakesEvent(GeolocationEvent): - """This represents an external event with GeoNet NZ Quakes feed data.""" + """Represents an external event with GeoNet NZ Quakes feed data.""" _attr_icon = "mdi:pulse" _attr_should_poll = False diff --git a/homeassistant/components/geonetnz_quakes/sensor.py b/homeassistant/components/geonetnz_quakes/sensor.py index 9183aead169..8fb2ff8535b 100644 --- a/homeassistant/components/geonetnz_quakes/sensor.py +++ b/homeassistant/components/geonetnz_quakes/sensor.py @@ -40,7 +40,7 @@ async def async_setup_entry( class GeonetnzQuakesSensor(SensorEntity): - """This is a status sensor for the GeoNet NZ Quakes integration.""" + """Status sensor for the GeoNet NZ Quakes integration.""" _attr_should_poll = False diff --git a/homeassistant/components/geonetnz_volcano/sensor.py b/homeassistant/components/geonetnz_volcano/sensor.py index 25e02f44308..33a879eeb25 100644 --- a/homeassistant/components/geonetnz_volcano/sensor.py +++ b/homeassistant/components/geonetnz_volcano/sensor.py @@ -54,7 +54,7 @@ async def async_setup_entry( class GeonetnzVolcanoSensor(SensorEntity): - """This represents an external event with GeoNet NZ Volcano feed data.""" + """Represents an external event with GeoNet NZ Volcano feed data.""" _attr_should_poll = False diff --git a/homeassistant/components/group/binary_sensor.py b/homeassistant/components/group/binary_sensor.py index 815e3b76f0b..112b111bdca 100644 --- a/homeassistant/components/group/binary_sensor.py +++ b/homeassistant/components/group/binary_sensor.py @@ -1,4 +1,4 @@ -"""This platform allows several binary sensor to be grouped into one binary sensor.""" +"""Platform allowing several binary sensor to be grouped into one binary sensor.""" from __future__ import annotations import voluptuous as vol diff --git a/homeassistant/components/group/cover.py b/homeassistant/components/group/cover.py index 2ecfbeaca42..38928302eb1 100644 --- a/homeassistant/components/group/cover.py +++ b/homeassistant/components/group/cover.py @@ -1,4 +1,4 @@ -"""This platform allows several cover to be grouped into one cover.""" +"""Platform allowing several cover to be grouped into one cover.""" from __future__ import annotations from typing import Any diff --git a/homeassistant/components/group/fan.py b/homeassistant/components/group/fan.py index 682890dddd6..0c4c59d2454 100644 --- a/homeassistant/components/group/fan.py +++ b/homeassistant/components/group/fan.py @@ -1,4 +1,4 @@ -"""This platform allows several fans to be grouped into one fan.""" +"""Platform allowing several fans to be grouped into one fan.""" from __future__ import annotations from functools import reduce diff --git a/homeassistant/components/group/light.py b/homeassistant/components/group/light.py index 6315e79d61a..33d240a9a4d 100644 --- a/homeassistant/components/group/light.py +++ b/homeassistant/components/group/light.py @@ -1,4 +1,4 @@ -"""This platform allows several lights to be grouped into one light.""" +"""Platform allowing several lights to be grouped into one light.""" from __future__ import annotations from collections import Counter diff --git a/homeassistant/components/group/lock.py b/homeassistant/components/group/lock.py index 9c39e145528..07d08c7851d 100644 --- a/homeassistant/components/group/lock.py +++ b/homeassistant/components/group/lock.py @@ -1,4 +1,4 @@ -"""This platform allows several locks to be grouped into one lock.""" +"""Platform allowing several locks to be grouped into one lock.""" from __future__ import annotations import logging diff --git a/homeassistant/components/group/media_player.py b/homeassistant/components/group/media_player.py index a349a628004..3766c64cae5 100644 --- a/homeassistant/components/group/media_player.py +++ b/homeassistant/components/group/media_player.py @@ -1,4 +1,4 @@ -"""This platform allows several media players to be grouped into one media player.""" +"""Platform allowing several media players to be grouped into one media player.""" from __future__ import annotations from contextlib import suppress diff --git a/homeassistant/components/group/sensor.py b/homeassistant/components/group/sensor.py index 6c379832ced..265e1640d06 100644 --- a/homeassistant/components/group/sensor.py +++ b/homeassistant/components/group/sensor.py @@ -1,4 +1,4 @@ -"""This platform allows several sensors to be grouped into one sensor to provide numeric combinations.""" +"""Platform allowing several sensors to be grouped into one sensor to provide numeric combinations.""" from __future__ import annotations from collections.abc import Callable diff --git a/homeassistant/components/group/switch.py b/homeassistant/components/group/switch.py index 8b60e1f1402..4b6b959ba17 100644 --- a/homeassistant/components/group/switch.py +++ b/homeassistant/components/group/switch.py @@ -1,4 +1,4 @@ -"""This platform allows several switches to be grouped into one switch.""" +"""Platform allowing several switches to be grouped into one switch.""" from __future__ import annotations import logging diff --git a/homeassistant/components/hitron_coda/device_tracker.py b/homeassistant/components/hitron_coda/device_tracker.py index c9ee93634b2..df1189f9e76 100644 --- a/homeassistant/components/hitron_coda/device_tracker.py +++ b/homeassistant/components/hitron_coda/device_tracker.py @@ -45,7 +45,7 @@ Device = namedtuple("Device", ["mac", "name"]) class HitronCODADeviceScanner(DeviceScanner): - """This class scans for devices using the CODA's web interface.""" + """Scanner for devices using the CODA's web interface.""" def __init__(self, config): """Initialize the scanner.""" diff --git a/homeassistant/components/ign_sismologia/geo_location.py b/homeassistant/components/ign_sismologia/geo_location.py index e78dafae8ee..794da41ea12 100644 --- a/homeassistant/components/ign_sismologia/geo_location.py +++ b/homeassistant/components/ign_sismologia/geo_location.py @@ -141,7 +141,7 @@ class IgnSismologiaFeedEntityManager: class IgnSismologiaLocationEvent(GeolocationEvent): - """This represents an external event with IGN Sismologia feed data.""" + """Represents an external event with IGN Sismologia feed data.""" _attr_icon = "mdi:pulse" _attr_should_poll = False diff --git a/homeassistant/components/intellifire/fan.py b/homeassistant/components/intellifire/fan.py index 0f438569389..aa74480fef1 100644 --- a/homeassistant/components/intellifire/fan.py +++ b/homeassistant/components/intellifire/fan.py @@ -72,7 +72,7 @@ async def async_setup_entry( class IntellifireFan(IntellifireEntity, FanEntity): - """This is Fan entity for the fireplace.""" + """Fan entity for the fireplace.""" entity_description: IntellifireFanEntityDescription _attr_supported_features = FanEntityFeature.SET_SPEED diff --git a/homeassistant/components/intellifire/light.py b/homeassistant/components/intellifire/light.py index f1fd81ab452..5e7d5735a6c 100644 --- a/homeassistant/components/intellifire/light.py +++ b/homeassistant/components/intellifire/light.py @@ -49,7 +49,7 @@ INTELLIFIRE_LIGHTS: tuple[IntellifireLightEntityDescription, ...] = ( class IntellifireLight(IntellifireEntity, LightEntity): - """This is a Light entity for the fireplace.""" + """Light entity for the fireplace.""" entity_description: IntellifireLightEntityDescription _attr_color_mode = ColorMode.BRIGHTNESS diff --git a/homeassistant/components/linksys_smart/device_tracker.py b/homeassistant/components/linksys_smart/device_tracker.py index 3b0aeffaa6d..d0440c832c8 100644 --- a/homeassistant/components/linksys_smart/device_tracker.py +++ b/homeassistant/components/linksys_smart/device_tracker.py @@ -35,7 +35,7 @@ def get_scanner( class LinksysSmartWifiDeviceScanner(DeviceScanner): - """This class queries a Linksys Access Point.""" + """Class which queries a Linksys Access Point.""" def __init__(self, config): """Initialize the scanner.""" diff --git a/homeassistant/components/lirc/__init__.py b/homeassistant/components/lirc/__init__.py index c5ebf874681..cf76213a88e 100644 --- a/homeassistant/components/lirc/__init__.py +++ b/homeassistant/components/lirc/__init__.py @@ -42,7 +42,7 @@ def setup(hass: HomeAssistant, config: ConfigType) -> bool: class LircInterface(threading.Thread): - """This interfaces with the lirc daemon to read IR commands. + """Interfaces with the lirc daemon to read IR commands. When using lirc in blocking mode, sometimes repeated commands get produced in the next read of a command so we use a thread here to just wait diff --git a/homeassistant/components/luci/device_tracker.py b/homeassistant/components/luci/device_tracker.py index d18ecf8bd4e..f4ebe4376f3 100644 --- a/homeassistant/components/luci/device_tracker.py +++ b/homeassistant/components/luci/device_tracker.py @@ -46,7 +46,7 @@ def get_scanner(hass: HomeAssistant, config: ConfigType) -> LuciDeviceScanner | class LuciDeviceScanner(DeviceScanner): - """This class scans for devices connected to an OpenWrt router.""" + """Scanner for devices connected to an OpenWrt router.""" def __init__(self, config): """Initialize the scanner.""" diff --git a/homeassistant/components/mqtt/alarm_control_panel.py b/homeassistant/components/mqtt/alarm_control_panel.py index 86513113281..b685daaf6f1 100644 --- a/homeassistant/components/mqtt/alarm_control_panel.py +++ b/homeassistant/components/mqtt/alarm_control_panel.py @@ -1,4 +1,4 @@ -"""This platform enables the possibility to control a MQTT alarm.""" +"""Control a MQTT alarm.""" from __future__ import annotations import functools diff --git a/homeassistant/components/nmap_tracker/__init__.py b/homeassistant/components/nmap_tracker/__init__.py index 827fb93a012..0dafff996d0 100644 --- a/homeassistant/components/nmap_tracker/__init__.py +++ b/homeassistant/components/nmap_tracker/__init__.py @@ -132,7 +132,7 @@ def signal_device_update(mac_address) -> str: class NmapDeviceScanner: - """This class scans for devices using nmap.""" + """Scanner for devices using nmap.""" def __init__( self, hass: HomeAssistant, entry: ConfigEntry, devices: NmapTrackedDevices diff --git a/homeassistant/components/nsw_rural_fire_service_feed/geo_location.py b/homeassistant/components/nsw_rural_fire_service_feed/geo_location.py index 3eb598ffd3e..28e056e29fb 100644 --- a/homeassistant/components/nsw_rural_fire_service_feed/geo_location.py +++ b/homeassistant/components/nsw_rural_fire_service_feed/geo_location.py @@ -177,7 +177,7 @@ class NswRuralFireServiceFeedEntityManager: class NswRuralFireServiceLocationEvent(GeolocationEvent): - """This represents an external event with NSW Rural Fire Service data.""" + """Represents an external event with NSW Rural Fire Service data.""" _attr_should_poll = False _attr_source = SOURCE diff --git a/homeassistant/components/opnsense/device_tracker.py b/homeassistant/components/opnsense/device_tracker.py index b5c75f1cc21..527856ed56e 100644 --- a/homeassistant/components/opnsense/device_tracker.py +++ b/homeassistant/components/opnsense/device_tracker.py @@ -20,7 +20,7 @@ async def async_get_scanner( class OPNSenseDeviceScanner(DeviceScanner): - """This class queries a router running OPNsense.""" + """Class which queries a router running OPNsense.""" def __init__(self, client, interfaces): """Initialize the scanner.""" diff --git a/homeassistant/components/qld_bushfire/geo_location.py b/homeassistant/components/qld_bushfire/geo_location.py index fc9fd727615..1adddc48559 100644 --- a/homeassistant/components/qld_bushfire/geo_location.py +++ b/homeassistant/components/qld_bushfire/geo_location.py @@ -149,7 +149,7 @@ class QldBushfireFeedEntityManager: class QldBushfireLocationEvent(GeolocationEvent): - """This represents an external event with Qld Bushfire feed data.""" + """Represents an external event with Qld Bushfire feed data.""" _attr_icon = "mdi:fire" _attr_should_poll = False diff --git a/homeassistant/components/quantum_gateway/device_tracker.py b/homeassistant/components/quantum_gateway/device_tracker.py index 076c1d2722b..c8e23b68416 100644 --- a/homeassistant/components/quantum_gateway/device_tracker.py +++ b/homeassistant/components/quantum_gateway/device_tracker.py @@ -40,7 +40,7 @@ def get_scanner( class QuantumGatewayDeviceScanner(DeviceScanner): - """This class queries a Quantum Gateway.""" + """Class which queries a Quantum Gateway.""" def __init__(self, config): """Initialize the scanner.""" diff --git a/homeassistant/components/rainmachine/binary_sensor.py b/homeassistant/components/rainmachine/binary_sensor.py index 5815c0ce126..33650cfc2fe 100644 --- a/homeassistant/components/rainmachine/binary_sensor.py +++ b/homeassistant/components/rainmachine/binary_sensor.py @@ -1,4 +1,4 @@ -"""This platform provides binary sensors for key RainMachine data.""" +"""Binary sensors for key RainMachine data.""" from dataclasses import dataclass from homeassistant.components.binary_sensor import ( diff --git a/homeassistant/components/rainmachine/sensor.py b/homeassistant/components/rainmachine/sensor.py index 3d56ff59fc5..22943d73fcb 100644 --- a/homeassistant/components/rainmachine/sensor.py +++ b/homeassistant/components/rainmachine/sensor.py @@ -1,4 +1,4 @@ -"""This platform provides support for sensor data from RainMachine.""" +"""Support for sensor data from RainMachine.""" from __future__ import annotations from dataclasses import dataclass diff --git a/homeassistant/components/rainmachine/switch.py b/homeassistant/components/rainmachine/switch.py index ae445d82783..60db5085951 100644 --- a/homeassistant/components/rainmachine/switch.py +++ b/homeassistant/components/rainmachine/switch.py @@ -1,4 +1,4 @@ -"""This component provides support for RainMachine programs and zones.""" +"""Component providing support for RainMachine programs and zones.""" from __future__ import annotations import asyncio diff --git a/homeassistant/components/reolink/binary_sensor.py b/homeassistant/components/reolink/binary_sensor.py index 541ad9ec998..3c97087c89d 100644 --- a/homeassistant/components/reolink/binary_sensor.py +++ b/homeassistant/components/reolink/binary_sensor.py @@ -1,4 +1,4 @@ -"""This component provides support for Reolink binary sensors.""" +"""Component providing support for Reolink binary sensors.""" from __future__ import annotations from collections.abc import Callable diff --git a/homeassistant/components/reolink/camera.py b/homeassistant/components/reolink/camera.py index d14906a5782..4a270d6f5a6 100644 --- a/homeassistant/components/reolink/camera.py +++ b/homeassistant/components/reolink/camera.py @@ -1,4 +1,4 @@ -"""This component provides support for Reolink IP cameras.""" +"""Component providing support for Reolink IP cameras.""" from __future__ import annotations import logging diff --git a/homeassistant/components/reolink/host.py b/homeassistant/components/reolink/host.py index 73c0e70812c..9994afe79a8 100644 --- a/homeassistant/components/reolink/host.py +++ b/homeassistant/components/reolink/host.py @@ -1,4 +1,4 @@ -"""This component encapsulates the NVR/camera API and subscription.""" +"""Module which encapsulates the NVR/camera API and subscription.""" from __future__ import annotations import asyncio diff --git a/homeassistant/components/reolink/number.py b/homeassistant/components/reolink/number.py index e9b692fffe6..c1baf4b156f 100644 --- a/homeassistant/components/reolink/number.py +++ b/homeassistant/components/reolink/number.py @@ -1,4 +1,4 @@ -"""This component provides support for Reolink number entities.""" +"""Component providing support for Reolink number entities.""" from __future__ import annotations from collections.abc import Callable diff --git a/homeassistant/components/ring/binary_sensor.py b/homeassistant/components/ring/binary_sensor.py index 06872cc7338..d2c01bbd4f3 100644 --- a/homeassistant/components/ring/binary_sensor.py +++ b/homeassistant/components/ring/binary_sensor.py @@ -1,4 +1,4 @@ -"""This component provides HA sensor support for Ring Door Bell/Chimes.""" +"""Component providing HA sensor support for Ring Door Bell/Chimes.""" from __future__ import annotations from dataclasses import dataclass diff --git a/homeassistant/components/ring/camera.py b/homeassistant/components/ring/camera.py index f5d70a86cb3..e99fabfab2f 100644 --- a/homeassistant/components/ring/camera.py +++ b/homeassistant/components/ring/camera.py @@ -1,4 +1,4 @@ -"""This component provides support to the Ring Door Bell camera.""" +"""Component providing support to the Ring Door Bell camera.""" from __future__ import annotations from datetime import timedelta diff --git a/homeassistant/components/ring/light.py b/homeassistant/components/ring/light.py index e6b29b94fbf..143c333f600 100644 --- a/homeassistant/components/ring/light.py +++ b/homeassistant/components/ring/light.py @@ -1,4 +1,4 @@ -"""This component provides HA switch support for Ring Door Bell/Chimes.""" +"""Component providing HA switch support for Ring Door Bell/Chimes.""" from datetime import timedelta import logging from typing import Any diff --git a/homeassistant/components/ring/sensor.py b/homeassistant/components/ring/sensor.py index 027eccb1c3d..3d198ce7573 100644 --- a/homeassistant/components/ring/sensor.py +++ b/homeassistant/components/ring/sensor.py @@ -1,4 +1,4 @@ -"""This component provides HA sensor support for Ring Door Bell/Chimes.""" +"""Component providing HA sensor support for Ring Door Bell/Chimes.""" from __future__ import annotations from dataclasses import dataclass diff --git a/homeassistant/components/ring/siren.py b/homeassistant/components/ring/siren.py index b83d3e7b2ae..626444a9dcf 100644 --- a/homeassistant/components/ring/siren.py +++ b/homeassistant/components/ring/siren.py @@ -1,4 +1,4 @@ -"""This component provides HA Siren support for Ring Chimes.""" +"""Component providing HA Siren support for Ring Chimes.""" import logging from typing import Any diff --git a/homeassistant/components/ring/switch.py b/homeassistant/components/ring/switch.py index 0fa6e3b1114..9a3c80114e9 100644 --- a/homeassistant/components/ring/switch.py +++ b/homeassistant/components/ring/switch.py @@ -1,4 +1,4 @@ -"""This component provides HA switch support for Ring Door Bell/Chimes.""" +"""Component providing HA switch support for Ring Door Bell/Chimes.""" from datetime import timedelta import logging from typing import Any diff --git a/homeassistant/components/sky_hub/device_tracker.py b/homeassistant/components/sky_hub/device_tracker.py index 65d806a9bca..8741b2ed560 100644 --- a/homeassistant/components/sky_hub/device_tracker.py +++ b/homeassistant/components/sky_hub/device_tracker.py @@ -39,7 +39,7 @@ async def async_get_scanner( class SkyHubDeviceScanner(DeviceScanner): - """This class queries a Sky Hub router.""" + """Class which queries a Sky Hub router.""" def __init__(self, hub): """Initialise the scanner.""" diff --git a/homeassistant/components/stookalert/binary_sensor.py b/homeassistant/components/stookalert/binary_sensor.py index 70a25c2bfdf..d3920d3f0e4 100644 --- a/homeassistant/components/stookalert/binary_sensor.py +++ b/homeassistant/components/stookalert/binary_sensor.py @@ -1,4 +1,4 @@ -"""This integration provides support for Stookalert Binary Sensor.""" +"""Support for Stookalert Binary Sensor.""" from __future__ import annotations from datetime import timedelta diff --git a/homeassistant/components/stookwijzer/sensor.py b/homeassistant/components/stookwijzer/sensor.py index 9eb70fda7ee..cd84bec11b2 100644 --- a/homeassistant/components/stookwijzer/sensor.py +++ b/homeassistant/components/stookwijzer/sensor.py @@ -1,4 +1,4 @@ -"""This integration provides support for Stookwijzer Sensor.""" +"""Support for Stookwijzer Sensor.""" from __future__ import annotations from datetime import timedelta diff --git a/homeassistant/components/swisscom/device_tracker.py b/homeassistant/components/swisscom/device_tracker.py index 29da03b262e..900117a54b7 100644 --- a/homeassistant/components/swisscom/device_tracker.py +++ b/homeassistant/components/swisscom/device_tracker.py @@ -36,7 +36,7 @@ def get_scanner( class SwisscomDeviceScanner(DeviceScanner): - """This class queries a router running Swisscom Internet-Box firmware.""" + """Class which queries a router running Swisscom Internet-Box firmware.""" def __init__(self, config): """Initialize the scanner.""" diff --git a/homeassistant/components/synology_srm/device_tracker.py b/homeassistant/components/synology_srm/device_tracker.py index 15c61ff0a3c..e67f7ecf34e 100644 --- a/homeassistant/components/synology_srm/device_tracker.py +++ b/homeassistant/components/synology_srm/device_tracker.py @@ -80,7 +80,7 @@ def get_scanner( class SynologySrmDeviceScanner(DeviceScanner): - """This class scans for devices connected to a Synology SRM router.""" + """Scanner for devices connected to a Synology SRM router.""" def __init__(self, config): """Initialize the scanner.""" diff --git a/homeassistant/components/tado/device_tracker.py b/homeassistant/components/tado/device_tracker.py index 72eb9c8e289..4d50bc35c3b 100644 --- a/homeassistant/components/tado/device_tracker.py +++ b/homeassistant/components/tado/device_tracker.py @@ -48,7 +48,7 @@ Device = namedtuple("Device", ["mac", "name"]) class TadoDeviceScanner(DeviceScanner): - """This class gets geofenced devices from Tado.""" + """Scanner for geofenced devices from Tado.""" def __init__(self, hass, config): """Initialize the scanner.""" diff --git a/homeassistant/components/thomson/device_tracker.py b/homeassistant/components/thomson/device_tracker.py index 4af21ec8e16..e42ee4478e0 100644 --- a/homeassistant/components/thomson/device_tracker.py +++ b/homeassistant/components/thomson/device_tracker.py @@ -46,7 +46,7 @@ def get_scanner(hass: HomeAssistant, config: ConfigType) -> ThomsonDeviceScanner class ThomsonDeviceScanner(DeviceScanner): - """This class queries a router running THOMSON firmware.""" + """Class which queries a router running THOMSON firmware.""" def __init__(self, config): """Initialize the scanner.""" diff --git a/homeassistant/components/tomato/device_tracker.py b/homeassistant/components/tomato/device_tracker.py index e10bc3b81d6..da64157dad8 100644 --- a/homeassistant/components/tomato/device_tracker.py +++ b/homeassistant/components/tomato/device_tracker.py @@ -49,7 +49,7 @@ def get_scanner(hass: HomeAssistant, config: ConfigType) -> TomatoDeviceScanner: class TomatoDeviceScanner(DeviceScanner): - """This class queries a wireless router running Tomato firmware.""" + """Class which queries a wireless router running Tomato firmware.""" def __init__(self, config): """Initialize the scanner.""" diff --git a/homeassistant/components/travisci/sensor.py b/homeassistant/components/travisci/sensor.py index ec62da37653..6a30c1b62ba 100644 --- a/homeassistant/components/travisci/sensor.py +++ b/homeassistant/components/travisci/sensor.py @@ -1,4 +1,4 @@ -"""This component provides HA sensor support for Travis CI framework.""" +"""Component providing HA sensor support for Travis CI framework.""" from __future__ import annotations from datetime import timedelta diff --git a/homeassistant/components/ubus/device_tracker.py b/homeassistant/components/ubus/device_tracker.py index 20b0ad6593d..48d5b4bd6f6 100644 --- a/homeassistant/components/ubus/device_tracker.py +++ b/homeassistant/components/ubus/device_tracker.py @@ -68,7 +68,7 @@ def _refresh_on_access_denied(func): class UbusDeviceScanner(DeviceScanner): - """This class queries a wireless router running OpenWrt firmware. + """Class which queries a wireless router running OpenWrt firmware. Adapted from Tomato scanner. """ diff --git a/homeassistant/components/unifi_direct/device_tracker.py b/homeassistant/components/unifi_direct/device_tracker.py index 42f83dad5d5..13ebd0e33e5 100644 --- a/homeassistant/components/unifi_direct/device_tracker.py +++ b/homeassistant/components/unifi_direct/device_tracker.py @@ -43,7 +43,7 @@ def get_scanner(hass: HomeAssistant, config: ConfigType) -> UnifiDeviceScanner | class UnifiDeviceScanner(DeviceScanner): - """This class queries Unifi wireless access point.""" + """Class which queries Unifi wireless access point.""" def __init__(self, config): """Initialize the scanner.""" diff --git a/homeassistant/components/unifiprotect/binary_sensor.py b/homeassistant/components/unifiprotect/binary_sensor.py index d61a47e8c7a..7aa7c6d5cf1 100644 --- a/homeassistant/components/unifiprotect/binary_sensor.py +++ b/homeassistant/components/unifiprotect/binary_sensor.py @@ -1,4 +1,4 @@ -"""This component provides binary sensors for UniFi Protect.""" +"""Component providing binary sensors for UniFi Protect.""" from __future__ import annotations from copy import copy diff --git a/homeassistant/components/unifiprotect/light.py b/homeassistant/components/unifiprotect/light.py index feb0be66ecd..500b4b4703e 100644 --- a/homeassistant/components/unifiprotect/light.py +++ b/homeassistant/components/unifiprotect/light.py @@ -1,4 +1,4 @@ -"""This component provides Lights for UniFi Protect.""" +"""Component providing Lights for UniFi Protect.""" from __future__ import annotations import logging diff --git a/homeassistant/components/unifiprotect/number.py b/homeassistant/components/unifiprotect/number.py index ba6ae819dd2..247e401b2ca 100644 --- a/homeassistant/components/unifiprotect/number.py +++ b/homeassistant/components/unifiprotect/number.py @@ -1,4 +1,4 @@ -"""This component provides number entities for UniFi Protect.""" +"""Component providing number entities for UniFi Protect.""" from __future__ import annotations from dataclasses import dataclass diff --git a/homeassistant/components/unifiprotect/select.py b/homeassistant/components/unifiprotect/select.py index 7fe43bee9bb..36870bf9c37 100644 --- a/homeassistant/components/unifiprotect/select.py +++ b/homeassistant/components/unifiprotect/select.py @@ -1,4 +1,4 @@ -"""This component provides select entities for UniFi Protect.""" +"""Component providing select entities for UniFi Protect.""" from __future__ import annotations from collections.abc import Callable diff --git a/homeassistant/components/unifiprotect/sensor.py b/homeassistant/components/unifiprotect/sensor.py index 5b17ed0020c..783955b3401 100644 --- a/homeassistant/components/unifiprotect/sensor.py +++ b/homeassistant/components/unifiprotect/sensor.py @@ -1,4 +1,4 @@ -"""This component provides sensors for UniFi Protect.""" +"""Component providing sensors for UniFi Protect.""" from __future__ import annotations from dataclasses import dataclass diff --git a/homeassistant/components/unifiprotect/switch.py b/homeassistant/components/unifiprotect/switch.py index 295b7014261..ea2d8256cbe 100644 --- a/homeassistant/components/unifiprotect/switch.py +++ b/homeassistant/components/unifiprotect/switch.py @@ -1,4 +1,4 @@ -"""This component provides Switches for UniFi Protect.""" +"""Component providing Switches for UniFi Protect.""" from __future__ import annotations from dataclasses import dataclass diff --git a/homeassistant/components/upc_connect/device_tracker.py b/homeassistant/components/upc_connect/device_tracker.py index 3025ea746d0..2b5ee2915ef 100644 --- a/homeassistant/components/upc_connect/device_tracker.py +++ b/homeassistant/components/upc_connect/device_tracker.py @@ -57,7 +57,7 @@ async def async_get_scanner( class UPCDeviceScanner(DeviceScanner): - """This class queries a router running UPC ConnectBox firmware.""" + """Class which queries a router running UPC ConnectBox firmware.""" def __init__(self, connect_box: ConnectBox) -> None: """Initialize the scanner.""" diff --git a/homeassistant/components/usgs_earthquakes_feed/geo_location.py b/homeassistant/components/usgs_earthquakes_feed/geo_location.py index 28927baf926..99aecfc406b 100644 --- a/homeassistant/components/usgs_earthquakes_feed/geo_location.py +++ b/homeassistant/components/usgs_earthquakes_feed/geo_location.py @@ -195,7 +195,7 @@ class UsgsEarthquakesFeedEntityManager: class UsgsEarthquakesEvent(GeolocationEvent): - """This represents an external event with USGS Earthquake data.""" + """Represents an external event with USGS Earthquake data.""" _attr_icon = "mdi:pulse" _attr_should_poll = False diff --git a/homeassistant/components/xiaomi/camera.py b/homeassistant/components/xiaomi/camera.py index 8b7abcd2fe6..e9d686a6365 100644 --- a/homeassistant/components/xiaomi/camera.py +++ b/homeassistant/components/xiaomi/camera.py @@ -1,4 +1,4 @@ -"""This component provides support for Xiaomi Cameras.""" +"""Component providing support for Xiaomi Cameras.""" from __future__ import annotations from ftplib import FTP, error_perm diff --git a/homeassistant/components/xiaomi/device_tracker.py b/homeassistant/components/xiaomi/device_tracker.py index b8cf5f005c4..f277060304a 100644 --- a/homeassistant/components/xiaomi/device_tracker.py +++ b/homeassistant/components/xiaomi/device_tracker.py @@ -36,7 +36,7 @@ def get_scanner(hass: HomeAssistant, config: ConfigType) -> XiaomiDeviceScanner class XiaomiDeviceScanner(DeviceScanner): - """This class queries a Xiaomi Mi router. + """Class which queries a Xiaomi Mi router. Adapted from Luci scanner. """ diff --git a/homeassistant/components/xiaomi_miio/device_tracker.py b/homeassistant/components/xiaomi_miio/device_tracker.py index e4bebdd0e62..977dc29ac42 100644 --- a/homeassistant/components/xiaomi_miio/device_tracker.py +++ b/homeassistant/components/xiaomi_miio/device_tracker.py @@ -53,7 +53,7 @@ def get_scanner( class XiaomiMiioDeviceScanner(DeviceScanner): - """This class queries a Xiaomi Mi WiFi Repeater.""" + """Class which queries a Xiaomi Mi WiFi Repeater.""" def __init__(self, device): """Initialize the scanner."""