Skip to content

Commit 2a15cdf

Browse files
authored
Merge pull request #823 from mslw/doc-filter-files
DOC: fix the description of filter_files
2 parents 1d420e5 + 7cb7e5e commit 2a15cdf

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

docs/heuristics.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,10 @@ But it is not used directly by HeuDiConv.
8383
A utility function used to filter any input files.
8484

8585
If this function is included, every file found will go through this filter. Any
86-
files where this function returns ``True`` will be filtered out.
86+
files where this function returns ``False`` will be filtered out (files where
87+
this function returns ``True`` will be kept).
88+
Note: this function's logic is opposite to ``filter_dicom`` (see
89+
below). Think of it as an input for Python's built-in ``filter()``.
8790

8891
--------------------------
8992
``filter_dicom(dcm_data)``

0 commit comments

Comments
 (0)