From bdfe450485651e9f56ac45519730d64b925b523e Mon Sep 17 00:00:00 2001
From: viglia <francesco.vigliaturo@sentry.io>
Date: Thu, 12 Sep 2024 17:29:03 +0200
Subject: [PATCH] ref(doc): add documentation for the ReadinessState enum
 (#6295)

Adding some doc for the `ReadinessState` _Enum_ class to explain its use
and the meaning of each of its members.
---
 snuba/datasets/readiness_state.py | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/snuba/datasets/readiness_state.py b/snuba/datasets/readiness_state.py
index ca4bc96f1d..ada34b7f62 100644
--- a/snuba/datasets/readiness_state.py
+++ b/snuba/datasets/readiness_state.py
@@ -4,6 +4,26 @@
 
 
 class ReadinessState(Enum):
+    """
+    Readiness states are essentially feature flags for snuba datasets.
+    The readiness state defines whether or not a dataset is made available
+    in specific sentry environments.
+    Currently, sentry environments include the following:
+    * local/CI
+    * SaaS
+    * S4S
+    * Self-Hosted
+    * Single-Tenant
+
+    The following is a list of readiness states and the environments
+    they map to:
+    * limited -> local/CI
+    * experimental -> local/CI, S4S
+    * partial -> local/CI, SaaS, S4S
+    * deprecate -> local/CI, Self-Hosted
+    * complete ->  local/CI, SaaS, S4S, Self-Hosted, Single-Tenant
+    """
+
     LIMITED = "limited"
     DEPRECATE = "deprecate"
     PARTIAL = "partial"