documenting env global

ak7vv · Jul 25, 2024 · bc62b3d · bc62b3d
1 parent 7eed54c
commit bc62b3d
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/api/globals.py b/api/globals.py
@@ -1,2 +1,7 @@
 
 env = {}
+    """This Dict is set by internal.check_env_vars and contains a subset of the environment relevant to this
+    application.  If a value isn't provided in the environment, check_env_vars will populate a reasonable
+    default.  In turn, components of this application can refer to env[] to retrieve global settings to
+    bootstrap. 
+    """