Fix stale docstrings in tplink integration (#135183)

This commit is contained in:
Steven B. 2025-01-09 11:37:32 +00:00 committed by GitHub
parent 8e28b7b49b
commit 1550086dd6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 10 additions and 10 deletions

View File

@ -23,7 +23,7 @@ from .entity import CoordinatedTPLinkFeatureEntity, TPLinkFeatureEntityDescripti
class TPLinkBinarySensorEntityDescription( class TPLinkBinarySensorEntityDescription(
BinarySensorEntityDescription, TPLinkFeatureEntityDescription BinarySensorEntityDescription, TPLinkFeatureEntityDescription
): ):
"""Base class for a TPLink feature based sensor entity description.""" """Base class for a TPLink feature based binary sensor entity description."""
# Coordinator is used to centralize the data updates # Coordinator is used to centralize the data updates

View File

@ -31,7 +31,7 @@ _LOGGER = logging.getLogger(__name__)
class TPLinkNumberEntityDescription( class TPLinkNumberEntityDescription(
NumberEntityDescription, TPLinkFeatureEntityDescription NumberEntityDescription, TPLinkFeatureEntityDescription
): ):
"""Base class for a TPLink feature based sensor entity description.""" """Base class for a TPLink feature based number entity description."""
# Coordinator is used to centralize the data updates # Coordinator is used to centralize the data updates
@ -74,7 +74,7 @@ async def async_setup_entry(
config_entry: TPLinkConfigEntry, config_entry: TPLinkConfigEntry,
async_add_entities: AddEntitiesCallback, async_add_entities: AddEntitiesCallback,
) -> None: ) -> None:
"""Set up sensors.""" """Set up number entities."""
data = config_entry.runtime_data data = config_entry.runtime_data
parent_coordinator = data.parent_coordinator parent_coordinator = data.parent_coordinator
children_coordinators = data.children_coordinators children_coordinators = data.children_coordinators
@ -93,7 +93,7 @@ async def async_setup_entry(
class TPLinkNumberEntity(CoordinatedTPLinkFeatureEntity, NumberEntity): class TPLinkNumberEntity(CoordinatedTPLinkFeatureEntity, NumberEntity):
"""Representation of a feature-based TPLink sensor.""" """Representation of a feature-based TPLink number entity."""
entity_description: TPLinkNumberEntityDescription entity_description: TPLinkNumberEntityDescription
@ -106,7 +106,7 @@ class TPLinkNumberEntity(CoordinatedTPLinkFeatureEntity, NumberEntity):
description: TPLinkFeatureEntityDescription, description: TPLinkFeatureEntityDescription,
parent: Device | None = None, parent: Device | None = None,
) -> None: ) -> None:
"""Initialize the a switch.""" """Initialize the number entity."""
super().__init__( super().__init__(
device, coordinator, feature=feature, description=description, parent=parent device, coordinator, feature=feature, description=description, parent=parent
) )

View File

@ -24,7 +24,7 @@ from .entity import (
class TPLinkSelectEntityDescription( class TPLinkSelectEntityDescription(
SelectEntityDescription, TPLinkFeatureEntityDescription SelectEntityDescription, TPLinkFeatureEntityDescription
): ):
"""Base class for a TPLink feature based sensor entity description.""" """Base class for a TPLink feature based select entity description."""
# Coordinator is used to centralize the data updates # Coordinator is used to centralize the data updates
@ -51,7 +51,7 @@ async def async_setup_entry(
config_entry: TPLinkConfigEntry, config_entry: TPLinkConfigEntry,
async_add_entities: AddEntitiesCallback, async_add_entities: AddEntitiesCallback,
) -> None: ) -> None:
"""Set up sensors.""" """Set up select entities."""
data = config_entry.runtime_data data = config_entry.runtime_data
parent_coordinator = data.parent_coordinator parent_coordinator = data.parent_coordinator
children_coordinators = data.children_coordinators children_coordinators = data.children_coordinators

View File

@ -1,4 +1,4 @@
"""Support for TPLink hub alarm.""" """Support for TPLink siren entity."""
from __future__ import annotations from __future__ import annotations
@ -35,7 +35,7 @@ async def async_setup_entry(
class TPLinkSirenEntity(CoordinatedTPLinkEntity, SirenEntity): class TPLinkSirenEntity(CoordinatedTPLinkEntity, SirenEntity):
"""Representation of a tplink hub alarm.""" """Representation of a tplink siren entity."""
_attr_name = None _attr_name = None
_attr_supported_features = SirenEntityFeature.TURN_OFF | SirenEntityFeature.TURN_ON _attr_supported_features = SirenEntityFeature.TURN_OFF | SirenEntityFeature.TURN_ON

View File

@ -26,7 +26,7 @@ _LOGGER = logging.getLogger(__name__)
class TPLinkSwitchEntityDescription( class TPLinkSwitchEntityDescription(
SwitchEntityDescription, TPLinkFeatureEntityDescription SwitchEntityDescription, TPLinkFeatureEntityDescription
): ):
"""Base class for a TPLink feature based sensor entity description.""" """Base class for a TPLink feature based switch entity description."""
# Coordinator is used to centralize the data updates # Coordinator is used to centralize the data updates