Module documentation docstrings

1 files changed, 12 insertions, 0 deletions

diff --git a/localsettingsWSL.py b/localsettingsWSL.py
index 01133ba..0034fdd 100644
--- a/localsettingsWSL.py
+++ b/localsettingsWSL.py
@@ -1,6 +1,18 @@
 import sys
 import os
 import urllib.parse
+"""Settings for a troggle installation which may vary among different
+installations: for development or deployment, in a docker image or
+python virtual environment (venv), on ubuntu, debian or in Windows
+System for Linux (WSL), on the main server or in the potato hut,
+using SQLite or mariaDB.
+
+It sets the directory locations for the major parts of the system so
+that e.g. expofiles can be on a different filesystem.
+
+This file is included at the end of the main troggle/settings.py file so that
+it overwrites defaults in that file.
+"""
 
 # link 'localsettings.py' to localsettingsWSL.py for use on a Windows 10 machine running WSL1
 print(" * importing troggle/localsettings.py")