changeset 269:7ef4362ca7c5

Docu
author Franz Glasner <fzglas.hg@dom66.de>
date Thu, 10 Sep 2020 09:27:34 +0200
parents 1484f6c0223a
children e73884fe060b
files configmix/__init__.py
diffstat 1 files changed, 4 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/configmix/__init__.py	Thu Sep 10 09:22:30 2020 +0200
+++ b/configmix/__init__.py	Thu Sep 10 09:27:34 2020 +0200
@@ -49,7 +49,10 @@
     """Load the given configuration files, merge them in the given order
     and return the resulting configuration dictionary.
 
-    :param files: the filenames of the configuration files to read and merge
+    :param files: the filenames of the configuration files to read and merge;
+                  if a filename starts with ``<dir>`` then the name is 
+                  interpreted as directory and all files are loaded in
+                  sorted order (non-resursively, ignoring unknown filetypes)
     :keyword defaults: optional configuration dictionary with some default
                        settings where the settings from `files` are merged
                        into