style: improve docstr

bakdata · Sep 26, 2023 · 296f6e7 · 296f6e7
1 parent 47155f1
commit 296f6e7
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/hooks/gen_docs/__init__.py b/hooks/gen_docs/__init__.py
@@ -5,7 +5,11 @@
 
 
 class IterableStrEnum(str, Enum):
-    """Temporary replacement for StrEnum while we suppport python3.10"""
+    """Polyfill that also introduces dict-like behavior
+
+    Introduces constructors that return a ``Generator`` object
+    either containing all items, only their names or their values.
+    """
 
     @classmethod
     def items(cls) -> Iterator[tuple[str, str]]: