diff configmix/__init__.py @ 56:1f11672c4615

Optimize the documentation: make references working with Sphinx using :role:`target`
author Franz Glasner <hg@dom66.de>
date Wed, 28 Feb 2018 00:36:11 +0100
parents aa8345dae995
children 7dfcfc96f533
line wrap: on
line diff
--- a/configmix/__init__.py	Tue Feb 27 23:57:57 2018 +0100
+++ b/configmix/__init__.py	Wed Feb 28 00:36:11 2018 +0100
@@ -29,7 +29,7 @@
 
 def load(*files):
     """Load the given configuration files, merge them in the given order
-    and return the resulting `Configuration` dictionary.
+    and return the resulting :class:`configmix.config.Configuration` dictionary.
 
     """
     if not files:
@@ -99,7 +99,7 @@
 
 
 def safe_merge(user, default, _first=True):
-    """A more safe version of `merge()` that makes shallow copies of
+    """A more safe version of :func:`merge()` that makes shallow copies of
     the returned container objects.
 
     .. note:: `_first` is an internal argument.