From 14c8c28b9a24b217a232203fd33517b600ee6da3 Mon Sep 17 00:00:00 2001 From: "Dustin C. Hatch" Date: Mon, 21 Jan 2013 22:10:24 -0600 Subject: [PATCH] Update docstring for util.read_config --- src/milla/util.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/milla/util.py b/src/milla/util.py index db0c4a6..14e3b02 100644 --- a/src/milla/util.py +++ b/src/milla/util.py @@ -72,6 +72,8 @@ def read_config(filename, defaults=None): '''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 (.) @@ -101,6 +103,7 @@ def read_config(filename, defaults=None): 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) '''