[doc] Docstring for discovery.

JasperVanDenBosch · Feb 21, 2015 · 80034fa · 80034fa
1 parent 610cf4b
commit 80034fa
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/niprov/discovery.py b/niprov/discovery.py
@@ -10,6 +10,16 @@
 
 def discover(root, filefilter=FileFilter(), filesys=Filesystem(), 
         listener=Commandline(), repository=JsonFile()):
+    """
+    Search a directory for image files, inspect them and store provenance.
+
+    Files are only included if they match the filters in the 
+    'discovery-filter.txt' file.
+    If a file is already known, it will be ignored and the listener informed.
+
+    Args:
+        root (str): The top directory in which to look for new files.
+    """
     dirs = filesys.walk(root)
     for (root, sdirs, files) in dirs:
         for filename in files: