add docstring to serversettings

OpenMined · Oct 9, 2024 · 35eb264 · 35eb264
1 parent 8363788
commit 35eb264
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/syftbox/server/settings.py b/syftbox/server/settings.py
@@ -5,6 +5,16 @@
 
 
 class ServerSettings(BaseSettings):
+    """
+    Reads the server settings from the environment variables, using the prefix SYFTBOX_.
+
+    example:
+    `export SYFTBOX_DATA_FOLDER=data/data_folder`
+    will set the server_settings.data_folder to `data/data_folder`
+
+    see: https://docs.pydantic.dev/latest/concepts/pydantic_settings/#parsing-environment-variable-values
+    """
+
     model_config = SettingsConfigDict(env_prefix="SYFTBOX_")
 
     data_folder: Path = Path("data")