added docstrings to helper functions in tiffimagingextractors

catalystneuro · Sep 5, 2023 · c3529d6 · c3529d6
1 parent 6a1a83f
commit c3529d6
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/src/roiextractors/extractors/tiffimagingextractors/micromanagertiffimagingextractor.py b/src/roiextractors/extractors/tiffimagingextractors/micromanagertiffimagingextractor.py
@@ -24,13 +24,15 @@
 
 
 def filter_tiff_tag_warnings(record):
+    """Filter out the warning messages from tifffile package."""
     return not record.msg.startswith("<tifffile.TiffTag 270 @42054>")
 
 
 logging.getLogger("tifffile.tifffile").addFilter(filter_tiff_tag_warnings)
 
 
 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
@@ -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