From cf219d5a48daf6583533cf1c515cbfe7f6d4fe8a Mon Sep 17 00:00:00 2001 From: Fabio Manganiello Date: Wed, 22 Feb 2023 01:02:26 +0100 Subject: [PATCH] Added some more docstrings to entities. --- platypush/entities/devices.py | 4 ++++ platypush/entities/dimmers.py | 5 +++++ 2 files changed, 9 insertions(+) diff --git a/platypush/entities/devices.py b/platypush/entities/devices.py index 3db19dd9..a65e50b3 100644 --- a/platypush/entities/devices.py +++ b/platypush/entities/devices.py @@ -8,6 +8,10 @@ from ._base import Entity if 'device' not in Base.metadata: class Device(Entity): + """ + Base class to model device entities. + """ + __tablename__ = 'device' id = Column( diff --git a/platypush/entities/dimmers.py b/platypush/entities/dimmers.py index c977b064..bdfa1d93 100644 --- a/platypush/entities/dimmers.py +++ b/platypush/entities/dimmers.py @@ -8,6 +8,11 @@ from .devices import Device if 'dimmer' not in Base.metadata: class Dimmer(Device): + """ + This class models dimmer entities. A dimmer is any actionable entity + with numeric values and an optional min/max range. + """ + __tablename__ = 'dimmer' id = Column(