From 4f60ba35eb73b2e8b54dd494a40bac86e04c274c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Martin=20P=C3=A9pin?= <kerl@wkerl.me>
Date: Mon, 8 Feb 2021 19:19:54 +0100
Subject: [PATCH] Update the settings' docstrings

---
 gestioasso/settings/bds_prod.py       | 6 ++++--
 gestioasso/settings/cof_prod.py       | 6 ++++--
 gestioasso/settings/common.py         | 5 +----
 gestioasso/settings/dev.py            | 8 +++++++-
 gestioasso/settings/local.py          | 7 ++++++-
 gestioasso/settings/secret_example.py | 4 ++++
 6 files changed, 26 insertions(+), 10 deletions(-)

diff --git a/gestioasso/settings/bds_prod.py b/gestioasso/settings/bds_prod.py
index 12f5a552..361ed7cb 100644
--- a/gestioasso/settings/bds_prod.py
+++ b/gestioasso/settings/bds_prod.py
@@ -1,7 +1,9 @@
 """
-Django development settings for the cof project.
-The settings that are not listed here are imported from .common
+Settings de production de GestioBDS.
+
+Surcharge les settings définis dans common.py
 """
+
 from .common import *  # NOQA
 from .common import INSTALLED_APPS
 
diff --git a/gestioasso/settings/cof_prod.py b/gestioasso/settings/cof_prod.py
index ec0694fe..d85e84c5 100644
--- a/gestioasso/settings/cof_prod.py
+++ b/gestioasso/settings/cof_prod.py
@@ -1,7 +1,9 @@
 """
-Django development settings for the cof project.
-The settings that are not listed here are imported from .common
+Settings de production de GestioCOF.
+
+Surcharge les settings définis dans common.py
 """
+
 import os
 
 from .common import *  # NOQA
diff --git a/gestioasso/settings/common.py b/gestioasso/settings/common.py
index 88ae636a..cabe7000 100644
--- a/gestioasso/settings/common.py
+++ b/gestioasso/settings/common.py
@@ -1,8 +1,5 @@
 """
-Django common settings for cof project.
-
-Everything which is supposed to be identical between the production server and
-the local development server should be here.
+Settings par défaut et settings communs à GestioCOF et GestioBDS.
 """
 
 import os
diff --git a/gestioasso/settings/dev.py b/gestioasso/settings/dev.py
index 7e1a63a8..cd254b7a 100644
--- a/gestioasso/settings/dev.py
+++ b/gestioasso/settings/dev.py
@@ -1,4 +1,10 @@
-"""Django local development settings."""
+"""
+Settings utilisés dans la VM Vagrant.
+Active toutes les applications (de GestioCOF et de GestioBDS).
+
+Surcharge les settings définis dans common.py
+"""
+
 import os
 
 from . import bds_prod
diff --git a/gestioasso/settings/local.py b/gestioasso/settings/local.py
index 0cc7b5e5..5c8c2734 100644
--- a/gestioasso/settings/local.py
+++ b/gestioasso/settings/local.py
@@ -1,4 +1,9 @@
-"""Django local development settings."""
+"""
+Settings utilisés lors d'un développement en local (dans un virtualenv).
+Active toutes les applications (de GestioCOF et de GestioBDS).
+
+Surcharge les settings définis dans common.py
+"""
 import os
 
 from . import bds_prod
diff --git a/gestioasso/settings/secret_example.py b/gestioasso/settings/secret_example.py
index 7921d467..8afce5cd 100644
--- a/gestioasso/settings/secret_example.py
+++ b/gestioasso/settings/secret_example.py
@@ -1,3 +1,7 @@
+"""
+Secrets à re-définir en production.
+"""
+
 SECRET_KEY = "q()(zn4m63i%5cp4)f+ww4-28_w+ly3q9=6imw2ciu&_(5_4ah"
 ADMINS = None
 SERVER_EMAIL = "root@vagrant"