# HG changeset patch
# User Franz Glasner <f.glasner@feldmann-mg.com>
# Date 1521647583 -3600
# Node ID d6ba53ce209162419e80310470f9202d33d9414a
# Parent  1b4d95f60650542311e0b5b456e8950895750e12
Better documentation of the core function in "configmix"

diff -r 1b4d95f60650 -r d6ba53ce2091 configmix/__init__.py
--- a/configmix/__init__.py	Sun Mar 18 19:15:01 2018 +0100
+++ b/configmix/__init__.py	Wed Mar 21 16:53:03 2018 +0100
@@ -28,7 +28,8 @@
 
 def load(*files):
     """Load the given configuration files, merge them in the given order
-    and return the resulting :class:`configmix.config.Configuration` dictionary.
+    and return the resulting :class:`configmix.config.Configuration`
+    dictionary.
 
     """
     if not files:
@@ -79,7 +80,13 @@
 
 
 def merge(user, default, _first=True):
-    """A simple (YAML-)tree merge.
+    """A simple (YAML-)tree-merge.
+
+    :param ~configmix.config.Configuration user:
+                the new configuration that will be merged into `default`
+    :param ~configmix.config.Configuration default:
+                the base configuration where `user` is merged into
+    :param bool _first: an intexrnal argument for controlling recursion
 
     From http://stackoverflow.com/questions/823196/yaml-merge-in-python