Skip to content

Commit 7cb7e5e

Browse files
yarikopticmslw
andauthored
Improve description for filter_files
Co-authored-by: Michał Szczepanik <[email protected]>
1 parent 869820a commit 7cb7e5e

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/heuristics.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,8 @@ A utility function used to filter any input files.
8585
If this function is included, every file found will go through this filter. Any
8686
files where this function returns ``False`` will be filtered out (files where
8787
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()``.
8890

8991
--------------------------
9092
``filter_dicom(dcm_data)``

0 commit comments

Comments
 (0)