From 3f16182dea62cd7889bc79633e0652d3bbfe797a Mon Sep 17 00:00:00 2001 From: Jasper Date: Fri, 2 Jan 2015 22:28:54 -0800 Subject: [PATCH] Documented Filefilter.include() --- niprov/filefilter.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/niprov/filefilter.py b/niprov/filefilter.py index 5756544..8e11878 100644 --- 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: