Improved comments for documentation

hubmapconsortium · Feb 4, 2025 · 5fe4527 · 5fe4527
1 parent 7e344f8
commit 5fe4527
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/src/portal_visualization/builders/imaging_builders.py b/src/portal_visualization/builders/imaging_builders.py
@@ -248,7 +248,7 @@ def __init__(self, entity, groups_token, assets_endpoint, **kwargs):
         self.view_type = KAGGLE_IMAGE_VIEW_TYPE
 
         # Needed to adjust to various directory structures. For older datasets, the image pyramids will be present in
-        # either 'processed_microscopy' , 'processedMicroscopy' while newer datasets have lab_processed as directory.
+        # 'processed_microscopy' or 'processedMicroscopy' while newer datasets are listed under lab_processed.
 
         image_dir = SEGMENTATION_SUPPORT_IMAGE_SUBDIR
         file_paths_found = self._get_file_paths()

diff --git a/src/portal_visualization/constants.py b/src/portal_visualization/constants.py
@@ -7,5 +7,7 @@
     "dm": 10
 }
 
-# To filter base image pyramids when finding segmentation mask images (kaggle-1, kaggle-2)
+# The base image pyramids for kaggle-1 and kaggle-2 may have various directory structures depending
+#  upon when they were processed. For older datasets, the image pyramids will be present
+#  either in 'processed_microscopy', or 'processedMicroscopy' while newer datasets will be listed under lab_processed.
 base_image_dirs = ['lab_processed', 'processed_microscopy', 'processedMicroscopy']