Apply suggestions from code review

Co-authored-by: Kabilar Gunalan <[email protected]>

Author: kushalbakshi

CHANGELOG.md

@@ -3,7 +3,7 @@
 Observes [Semantic Versioning](https://semver.org/spec/v2.0.0.html) standard and
 [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) convention.
 
-## [0.5.5] - 2023-07-26
+## [0.6.0] - 2023-07-26
 
 + Update - `prairieviewreader.py` -> `prairie_view_loader.py`
 + Update - Internal variable names within `prairie_view_loader.py`
@@ -76,7 +76,7 @@ Observes [Semantic Versioning](https://semver.org/spec/v2.0.0.html) standard and
 
 + Add - Readers for: `ScanImage`, `Suite2p`, `CaImAn`.
 
-[0.5.5]: https://github.com/datajoint/element-interface/releases/tag/0.5.5
+[0.6.0]: https://github.com/datajoint/element-interface/releases/tag/0.6.0
 [0.5.4]: https://github.com/datajoint/element-interface/releases/tag/0.5.4
 [0.5.3]: https://github.com/datajoint/element-interface/releases/tag/0.5.3
 [0.5.2]: https://github.com/datajoint/element-interface/releases/tag/0.5.2

element_interface/prairieviewreader.py

@@ -5,7 +5,7 @@
 import numpy as np
 
 
-def get_pv_metadata(ome_tif_filepath: str) -> dict:
+def get_prairieview_metadata(ome_tif_filepath: str) -> dict:
     """Extract metadata for scans generated by Prairie View acquisition software.
 
     The Prairie View software generates one `.ome.tif` imaging file per frame
@@ -14,7 +14,7 @@ def get_pv_metadata(ome_tif_filepath: str) -> dict:
     populate the DataJoint `ScanInfo` and `Field` tables. Prairie View works
     with resonance scanners with a single field. Prairie View does not support
     bidirectional x and y scanning. ROI information is not contained in the
-    `.xml` file. All images generated using PrairieView have square dimensions(e.g. 512x512).
+    `.xml` file. All images generated using Prairie View have square dimensions(e.g. 512x512).
 
     Args:
         ome_tif_filepath: An absolute path to the .ome.tif image file.
@@ -132,8 +132,8 @@ def get_pv_metadata(ome_tif_filepath: str) -> dict:
             ".//Sequence/[@cycle='1']/Frame/[@index='1']/PVStateShard/PVStateValue/[@key='positionCurrent']/SubindexedValues/[@index='ZAxis']/SubindexedValue"
         )
 
-        # If more than one Z-axis controllers are found, the code block below
-        # checks which controller is changing z_field depth. Only 1 controller
+        # If more than one Z-axis controllers are found, 
+        # check which controller is changing z_field depth. Only 1 controller
         # must change depths.
         if len(z_controllers) > 1:
             z_repeats = []

element_interface/version.py

@@ -1,3 +1,3 @@
 """Package metadata"""
 
-__version__ = "0.5.5"
+__version__ = "0.6.0"