Commits

Dustin Hatch committed 08b6066

Update docstring for util.read_config

Comments (0)

Files changed (1)

src/milla/util.py

     '''Parse an ini file into a nested dictionary
 
     :param string filename: Path to the ini file to read
+    :param dict defaults: (Optional) A mapping of default values that can be
+       used for interpolation when reading the configuration file
     :returns: A dictionary whose keys correspond to the section and
        option, joined with a dot character (.)
 
     This dictionary can be used to configure an :py:class:`~milla.Application`
     instance by using the ``update`` method::
 
+        config = milla.util.read_config('superheros.ini')
         app = milla.Application(router)
         app.config.update(config)
     '''