Mercurial > hgrepos > Python > libs > ConfigMix
diff configmix/__init__.py @ 274:90bbade12d8e
Docu: use local lookup firstly
| author | Franz Glasner <fzglas.hg@dom66.de> |
|---|---|
| date | Sat, 03 Oct 2020 15:50:41 +0200 |
| parents | 9733aaa261ac |
| children | e2fd8fea1a4c |
line wrap: on
line diff
--- a/configmix/__init__.py Sat Oct 03 10:52:15 2020 +0200 +++ b/configmix/__init__.py Sat Oct 03 15:50:41 2020 +0200 @@ -56,7 +56,7 @@ and return the resulting configuration dictionary. :param files: the filenames of the configuration files to read and merge; - if a filename starts with ``<dir>`` then the name is + 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 @@ -240,7 +240,7 @@ USE_DEFAULT_ASSOC = object() """Marker for the default association for an extension. -To be used in :func:`set_assoc`. +To be used in :func:`.set_assoc`. """ @@ -261,7 +261,7 @@ mode_loaders = {} """All configured associations between file modes and loader functions. -See :data:`DEFAULT_MODE_LOADERS`. +See :data:`.DEFAULT_MODE_LOADERS`. """ @@ -408,7 +408,7 @@ :param ~configmix.config.Configuration default: the base configuration where `user` is logically merged into :param bool filter_comments: flag whether to filter comment keys that - start with any of the items in :data:`COMMENTS` + start with any of the items in :data:`.COMMENTS` :returns: `user` with the necessary amendments from `default`. If `user` is ``None`` then `default` is returned. @@ -439,7 +439,7 @@ def _merge(user, default, filter_comments): - """Recursion helper for :meth:`merge` + """Recursion helper for :func:`merge` """ if isinstance(user, dict) and isinstance(default, dict): @@ -482,7 +482,7 @@ def _safe_merge(user, default, filter_comments): - """Recursion helper for :meth:`safe_merge` + """Recursion helper for :func:`safe_merge` """ if isinstance(user, dict) and isinstance(default, dict): @@ -500,7 +500,7 @@ """Recursively filter comments keys in the dict `d`. Comment keys are keys that start with any of the items in - :data:`COMMENTS`. + :data:`.COMMENTS`. """ if not isinstance(d, dict):
