From 2eebda63fdde17072b126c0d4b2de3d9c86b7cfa Mon Sep 17 00:00:00 2001 From: Brett Adams Date: Sun, 17 Jul 2022 22:00:01 +1000 Subject: [PATCH] Correct docstrings in Advantage Air (#75344) --- .../components/advantage_air/binary_sensor.py | 14 +++++++------- homeassistant/components/advantage_air/cover.py | 4 ++-- homeassistant/components/advantage_air/select.py | 4 ++-- homeassistant/components/advantage_air/switch.py | 2 +- tests/components/advantage_air/test_climate.py | 2 +- tests/components/advantage_air/test_cover.py | 2 +- tests/components/advantage_air/test_select.py | 4 ++-- tests/components/advantage_air/test_switch.py | 2 +- 8 files changed, 17 insertions(+), 17 deletions(-) diff --git a/homeassistant/components/advantage_air/binary_sensor.py b/homeassistant/components/advantage_air/binary_sensor.py index bc302e5d4a6..c87bf37ca92 100644 --- a/homeassistant/components/advantage_air/binary_sensor.py +++ b/homeassistant/components/advantage_air/binary_sensor.py @@ -21,7 +21,7 @@ async def async_setup_entry( config_entry: ConfigEntry, async_add_entities: AddEntitiesCallback, ) -> None: - """Set up AdvantageAir motion platform.""" + """Set up AdvantageAir Binary Sensor platform.""" instance = hass.data[ADVANTAGE_AIR_DOMAIN][config_entry.entry_id] @@ -39,13 +39,13 @@ async def async_setup_entry( class AdvantageAirFilter(AdvantageAirEntity, BinarySensorEntity): - """Advantage Air Filter.""" + """Advantage Air Filter sensor.""" _attr_device_class = BinarySensorDeviceClass.PROBLEM _attr_entity_category = EntityCategory.DIAGNOSTIC def __init__(self, instance, ac_key): - """Initialize an Advantage Air Filter.""" + """Initialize an Advantage Air Filter sensor.""" super().__init__(instance, ac_key) self._attr_name = f'{self._ac["name"]} filter' self._attr_unique_id = ( @@ -59,12 +59,12 @@ class AdvantageAirFilter(AdvantageAirEntity, BinarySensorEntity): class AdvantageAirZoneMotion(AdvantageAirEntity, BinarySensorEntity): - """Advantage Air Zone Motion.""" + """Advantage Air Zone Motion sensor.""" _attr_device_class = BinarySensorDeviceClass.MOTION def __init__(self, instance, ac_key, zone_key): - """Initialize an Advantage Air Zone Motion.""" + """Initialize an Advantage Air Zone Motion sensor.""" super().__init__(instance, ac_key, zone_key) self._attr_name = f'{self._zone["name"]} motion' self._attr_unique_id = ( @@ -78,13 +78,13 @@ class AdvantageAirZoneMotion(AdvantageAirEntity, BinarySensorEntity): class AdvantageAirZoneMyZone(AdvantageAirEntity, BinarySensorEntity): - """Advantage Air Zone MyZone.""" + """Advantage Air Zone MyZone sensor.""" _attr_entity_registry_enabled_default = False _attr_entity_category = EntityCategory.DIAGNOSTIC def __init__(self, instance, ac_key, zone_key): - """Initialize an Advantage Air Zone MyZone.""" + """Initialize an Advantage Air Zone MyZone sensor.""" super().__init__(instance, ac_key, zone_key) self._attr_name = f'{self._zone["name"]} myZone' self._attr_unique_id = ( diff --git a/homeassistant/components/advantage_air/cover.py b/homeassistant/components/advantage_air/cover.py index f8240126476..391f39953d2 100644 --- a/homeassistant/components/advantage_air/cover.py +++ b/homeassistant/components/advantage_air/cover.py @@ -40,7 +40,7 @@ async def async_setup_entry( class AdvantageAirZoneVent(AdvantageAirEntity, CoverEntity): - """Advantage Air Cover Class.""" + """Advantage Air Zone Vent.""" _attr_device_class = CoverDeviceClass.DAMPER _attr_supported_features = ( @@ -50,7 +50,7 @@ class AdvantageAirZoneVent(AdvantageAirEntity, CoverEntity): ) def __init__(self, instance, ac_key, zone_key): - """Initialize an Advantage Air Cover Class.""" + """Initialize an Advantage Air Zone Vent.""" super().__init__(instance, ac_key, zone_key) self._attr_name = self._zone["name"] self._attr_unique_id = ( diff --git a/homeassistant/components/advantage_air/select.py b/homeassistant/components/advantage_air/select.py index ff2a555bc80..0edae258279 100644 --- a/homeassistant/components/advantage_air/select.py +++ b/homeassistant/components/advantage_air/select.py @@ -15,7 +15,7 @@ async def async_setup_entry( config_entry: ConfigEntry, async_add_entities: AddEntitiesCallback, ) -> None: - """Set up AdvantageAir toggle platform.""" + """Set up AdvantageAir select platform.""" instance = hass.data[ADVANTAGE_AIR_DOMAIN][config_entry.entry_id] @@ -49,7 +49,7 @@ class AdvantageAirMyZone(AdvantageAirEntity, SelectEntity): @property def current_option(self): - """Return the fresh air status.""" + """Return the current MyZone.""" return self._number_to_name[self._ac["myZone"]] async def async_select_option(self, option): diff --git a/homeassistant/components/advantage_air/switch.py b/homeassistant/components/advantage_air/switch.py index 44be859aa63..3c0060c65b3 100644 --- a/homeassistant/components/advantage_air/switch.py +++ b/homeassistant/components/advantage_air/switch.py @@ -17,7 +17,7 @@ async def async_setup_entry( config_entry: ConfigEntry, async_add_entities: AddEntitiesCallback, ) -> None: - """Set up AdvantageAir toggle platform.""" + """Set up AdvantageAir switch platform.""" instance = hass.data[ADVANTAGE_AIR_DOMAIN][config_entry.entry_id] diff --git a/tests/components/advantage_air/test_climate.py b/tests/components/advantage_air/test_climate.py index 27f89d1df3e..47073f27fc1 100644 --- a/tests/components/advantage_air/test_climate.py +++ b/tests/components/advantage_air/test_climate.py @@ -34,7 +34,7 @@ from tests.components.advantage_air import ( async def test_climate_async_setup_entry(hass, aioclient_mock): - """Test climate setup.""" + """Test climate platform.""" aioclient_mock.get( TEST_SYSTEM_URL, diff --git a/tests/components/advantage_air/test_cover.py b/tests/components/advantage_air/test_cover.py index fa3abda5138..c638c6a3c87 100644 --- a/tests/components/advantage_air/test_cover.py +++ b/tests/components/advantage_air/test_cover.py @@ -27,7 +27,7 @@ from tests.components.advantage_air import ( async def test_cover_async_setup_entry(hass, aioclient_mock): - """Test climate setup without sensors.""" + """Test cover platform.""" aioclient_mock.get( TEST_SYSTEM_URL, diff --git a/tests/components/advantage_air/test_select.py b/tests/components/advantage_air/test_select.py index 41ed9c407fc..2ba982fc384 100644 --- a/tests/components/advantage_air/test_select.py +++ b/tests/components/advantage_air/test_select.py @@ -19,7 +19,7 @@ from tests.components.advantage_air import ( async def test_select_async_setup_entry(hass, aioclient_mock): - """Test climate setup without sensors.""" + """Test select platform.""" aioclient_mock.get( TEST_SYSTEM_URL, @@ -36,7 +36,7 @@ async def test_select_async_setup_entry(hass, aioclient_mock): assert len(aioclient_mock.mock_calls) == 1 - # Test Select Entity + # Test MyZone Select Entity entity_id = "select.testname_ac_one_myzone" state = hass.states.get(entity_id) assert state diff --git a/tests/components/advantage_air/test_switch.py b/tests/components/advantage_air/test_switch.py index 1d99d7f29c1..41af9e8ff80 100644 --- a/tests/components/advantage_air/test_switch.py +++ b/tests/components/advantage_air/test_switch.py @@ -23,7 +23,7 @@ from tests.components.advantage_air import ( async def test_cover_async_setup_entry(hass, aioclient_mock): - """Test climate setup without sensors.""" + """Test switch platform.""" aioclient_mock.get( TEST_SYSTEM_URL,