Documented Filefilter.include()

JasperVanDenBosch · Jan 3, 2015 · 3f16182 · 3f16182
1 parent 4bfa6b4
commit 3f16182
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/niprov/filefilter.py b/niprov/filefilter.py
@@ -16,6 +16,15 @@ def __init__(self, filesys=Filesystem()):
             self.filters = None
 
     def include(self, filepath):
+        """Whether the file is to be included in discovery.
+
+        :param filepath: The full path of the file.
+        :type filepath: str.
+        :rtype: bool
+        :returns: True if the file should be included.
+        :raises: ValueError
+
+        """
         if not self.filters:
             raise ValueError('Was not able to load filter file.')
         for filt in self.filters: