From c4aa8172d84c66418c9d1f33d8e14470e3d22bb4 Mon Sep 17 00:00:00 2001 From: James Robinson Date: Fri, 26 Apr 2024 16:38:00 +0100 Subject: [PATCH] :loud_sound: Improve ContextSettings docstring --- data_safe_haven/context/context_settings.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/data_safe_haven/context/context_settings.py b/data_safe_haven/context/context_settings.py index 2c1b35a9fd..8168a8f6f9 100644 --- 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) ... """