From 35eb264606f0fe8d69fd344d0d3e9229592a73fa Mon Sep 17 00:00:00 2001
From: eelcovdw <eelcovdw@gmail.com>
Date: Wed, 9 Oct 2024 14:06:22 +0200
Subject: [PATCH] add docstring to serversettings

---
 syftbox/server/settings.py | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/syftbox/server/settings.py b/syftbox/server/settings.py
index b84c9a82..3a83b0cc 100644
--- 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")