From e7d6875cab75f136c97c36eee7b546bb08d223f1 Mon Sep 17 00:00:00 2001
From: Stefan van der Walt <stefan@sun.ac.za>
Date: Sun, 1 Nov 2009 11:59:10 +0200
Subject: [PATCH] Document _call_plugin.

---
 scikits/image/io/io.py | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/scikits/image/io/io.py b/scikits/image/io/io.py
index 2ad75532..c4d61f99 100644
--- a/scikits/image/io/io.py
+++ b/scikits/image/io/io.py
@@ -3,6 +3,19 @@ __all__ = ['imread', 'imsave', 'imshow']
 from scikits.image.io.plugin import plugin_store
 
 def _call_plugin(kind, *args, **kwargs):
+    """Find the appropriate plugin of 'kind' and execute it.
+
+    Parameters
+    ----------
+    kind : {'imshow', 'imsave', 'imread'}
+        Function to look up.
+    plugin : str, optional
+        Plugin to load.  Defaults to None, in which case the first
+        matching plugin is used.
+    *args, **kwargs : arguments and keyword arguments
+        Passed to the plugin function.
+
+    """
     if not kind in plugin_store:
         raise ValueError('Invalid function (%s) requested.' % kind)