chore: update RemovelCause docstring to use Attributes section to des…

…cribe enum items
dgilland · Nov 3, 2023 · 9ca1954 · 9ca1954
1 parent 1a67797
commit 9ca1954
Showing 1 changed file with 7 additions and 6 deletions.
diff --git a/src/cacheout/cache.py b/src/cacheout/cache.py
@@ -30,12 +30,13 @@ class RemovalCause(Enum):
     """
     An enum to represent the cause for the removal of a cache entry.
 
-    - DELETE: indicates that the cache entry was deleted by delete() or delete_many() explicitly.
-    - SET: indicates that the cache entry was replaced with a new value by set() or set_many().
-    - EXPIRED: indicates that the cache entry was removed because it expired.
-    - FULL: indicates that the cache entry was removed because cache has been full
-        (reached the maximum size limit).
-    - POPITEM: indicates that the cache entry was deleted by popitem().
+    Attributes:
+        DELETE: indicates that the cache entry was deleted by delete() or delete_many() explicitly.
+        SET: indicates that the cache entry was replaced with a new value by set() or set_many().
+        EXPIRED: indicates that the cache entry was removed because it expired.
+        FULL: indicates that the cache entry was removed because cache has been full (reached the
+            maximum size limit).
+        POPITEM: indicates that the cache entry was deleted by popitem().
     """
 
     DELETE = auto()