comparison configmix/__init__.py @ 173:b3ba2b0265b5

Docu: Explicitely tag "defaults" as keyword argument
author Franz Glasner <f.glasner@feldmann-mg.com>
date Fri, 26 Apr 2019 15:27:29 +0200
parents 8138d56d7cd3
children e2505f524ab9
comparison
equal deleted inserted replaced
172:8138d56d7cd3 173:b3ba2b0265b5
44 def load(*files, **kwargs): 44 def load(*files, **kwargs):
45 """Load the given configuration files, merge them in the given order 45 """Load the given configuration files, merge them in the given order
46 and return the resulting configuration dictionary. 46 and return the resulting configuration dictionary.
47 47
48 :param files: the filenames of the configuration files to read and merge 48 :param files: the filenames of the configuration files to read and merge
49 :param defaults: optional configuration dictionary with some default 49 :keyword defaults: optional configuration dictionary with some default
50 settings where the settings from `files` are merged 50 settings where the settings from `files` are merged
51 into 51 into
52 :type defaults: a configuration dictionary or `None` 52 :type defaults: a configuration dictionary or `None`
53 :returns: the configuration 53 :returns: the configuration
54 :rtype: ~configmix.config.Configuration 54 :rtype: ~configmix.config.Configuration
55 55
56 """ 56 """