Mercurial > hgrepos > Python > libs > ConfigMix
diff configmix/__init__.py @ 98:d6ba53ce2091
Better documentation of the core function in "configmix"
| author | Franz Glasner <f.glasner@feldmann-mg.com> |
|---|---|
| date | Wed, 21 Mar 2018 16:53:03 +0100 |
| parents | 778c3bb1fb41 |
| children | 2ee042791197 |
line wrap: on
line diff
--- 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