🔊 Improve ContextSettings docstring

alan-turing-institute · Apr 26, 2024 · c4aa817 · c4aa817
1 parent cc8a86c
commit c4aa817
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/data_safe_haven/context/context_settings.py b/data_safe_haven/context/context_settings.py
@@ -101,7 +101,7 @@ def to_yaml(self) -> str:
 
 
 class ContextSettings(YAMLSerialisableModel, validate_assignment=True):
-    """Load global and local settings from dotfiles with structure like the following
+    """Load available and current contexts from YAML files structured as follows:
 
     selected: acme_deployment
     contexts:
@@ -110,6 +110,11 @@ class ContextSettings(YAMLSerialisableModel, validate_assignment=True):
             admin_group_id: d5c5c439-1115-4cb6-ab50-b8e547b6c8dd
             location: uksouth
             subscription_name: Data Safe Haven (Acme)
+        acme_testing:
+            name: Acme Testing
+            admin_group_id: 32ebe412-e198-41f3-88f6-bc6687eb471b
+            location: ukwest
+            subscription_name: Data Safe Haven (Acme Testing)
         ...
     """