Improve documentation of the behaviour of --extra-settings

Author: PeterJCLaw

django_lightweight_queue/management/commands/queue_configuration.py

@@ -5,6 +5,7 @@
 
 from ... import app_settings
 from ...utils import get_backend, get_queue_counts, load_extra_settings
+from ...constants import SETTING_NAME_PREFIX
 from ...cron_scheduler import get_cron_config
 
 
@@ -22,7 +23,9 @@ def add_arguments(self, parser: CommandParser) -> None:
             '--extra-settings',
             action='store',
             default=None,
-            help="The path to an additional django-style settings file to load",
+            help="The path to an additional django-style settings file to load. "
+                 f"{SETTING_NAME_PREFIX}* settings discovered in this file will "
+                 "override those from the default Django settings.",
         )
 
     def handle(self, **options: Any) -> None:

django_lightweight_queue/management/commands/queue_runner.py

@@ -18,6 +18,7 @@
     load_extra_settings,
 )
 from ...runner import runner
+from ...constants import SETTING_NAME_PREFIX
 from ...machine_types import Machine, PooledMachine, DirectlyConfiguredMachine
 
 
@@ -69,7 +70,9 @@ def add_arguments(self, parser: CommandParser) -> None:
             '--extra-settings',
             action='store',
             default=None,
-            help="The path to an additional django-style settings file to load",
+            help="The path to an additional django-style settings file to load. "
+                 f"{SETTING_NAME_PREFIX}* settings discovered in this file will "
+                 "override those from the default Django settings.",
         )
         parser.add_argument(
             '--exact-configuration',