From c3529d68fd6453d6b9dda772892cf3951332365e Mon Sep 17 00:00:00 2001 From: pauladkisson Date: Tue, 5 Sep 2023 14:36:53 -0700 Subject: [PATCH] added docstrings to helper functions in tiffimagingextractors --- .../tiffimagingextractors/micromanagertiffimagingextractor.py | 2 ++ .../tiffimagingextractors/scanimagetiffimagingextractor.py | 1 + 2 files changed, 3 insertions(+) diff --git a/src/roiextractors/extractors/tiffimagingextractors/micromanagertiffimagingextractor.py b/src/roiextractors/extractors/tiffimagingextractors/micromanagertiffimagingextractor.py index 21d79282..bfc64d6c 100644 --- a/src/roiextractors/extractors/tiffimagingextractors/micromanagertiffimagingextractor.py +++ b/src/roiextractors/extractors/tiffimagingextractors/micromanagertiffimagingextractor.py @@ -24,6 +24,7 @@ def filter_tiff_tag_warnings(record): + """Filter out the warning messages from tifffile package.""" return not record.msg.startswith("") @@ -31,6 +32,7 @@ def filter_tiff_tag_warnings(record): def _get_tiff_reader() -> ModuleType: + """Import the tifffile package and return the module.""" return get_package(package_name="tifffile", installation_instructions="pip install tifffile") diff --git a/src/roiextractors/extractors/tiffimagingextractors/scanimagetiffimagingextractor.py b/src/roiextractors/extractors/tiffimagingextractors/scanimagetiffimagingextractor.py index 98c21323..83a51916 100644 --- a/src/roiextractors/extractors/tiffimagingextractors/scanimagetiffimagingextractor.py +++ b/src/roiextractors/extractors/tiffimagingextractors/scanimagetiffimagingextractor.py @@ -16,6 +16,7 @@ def _get_scanimage_reader() -> type: + """Import the scanimage-tiff-reader package and return the ScanImageTiffReader class.""" return get_package( package_name="ScanImageTiffReader", installation_instructions="pip install scanimage-tiff-reader" ).ScanImageTiffReader