Add a docstring explaining Device.tags.

jaraco · Jul 8, 2024 · 8502d8f · 8502d8f
1 parent a87cab4
commit 8502d8f
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/jaraco/abode/devices/base.py b/jaraco/abode/devices/base.py
@@ -17,6 +17,11 @@ class Device(Stateful):
     """Class to represent each Abode device."""
 
     tags: Tuple[str, ...] = ()
+    """
+    Each device has a ``type_tag``, something like "device_type.door_lock".
+    Each Device subclass declares the tags that it services (with the
+    "device_type." prefix omitted).
+    """
     _desc_t = '{name} (ID: {id}, UUID: {uuid}) - {type} - {status}'
     _url_t = urls.DEVICE