From 2ebfcdce754df5710f323e3b29923d82e8e692cb Mon Sep 17 00:00:00 2001
From: Stefan van der Walt <stefan@sun.ac.za>
Date: Thu, 3 Dec 2009 10:11:09 +0200
Subject: [PATCH] Add docs for logger.

---
 scikits/image/__init__.py | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/scikits/image/__init__.py b/scikits/image/__init__.py
index 1a45c381..9cc4edc5 100644
--- a/scikits/image/__init__.py
+++ b/scikits/image/__init__.py
@@ -26,6 +26,22 @@ if test is None:
     del test
 
 def get_log(name):
+    """Return a console logger.
+
+    Output may be sent to the logger using the `debug`, `info`, `warning`,
+    `error` and `critical` methods.
+
+    Parameters
+    ----------
+    name : str
+        Name of the log.
+
+    References
+    ----------
+    .. [1] Logging facility for Python,
+           http://docs.python.org/library/logging.html
+
+    """
     import logging, sys
     logging.basicConfig(stream=sys.stdout, level=logging.DEBUG)
     return logging.getLogger(name)