Skip to content

Commit e99dcdb

Browse files
authored
Update docstring of locate_latest_imaris()
Details of the functionality are preferably explained in the first section of the docstring, as this is what another person will read first.
1 parent f9375c5 commit e99dcdb

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

src/imcflibs/imagej/misc.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -644,6 +644,10 @@ def pad_number(index, pad_length=2):
644644
def locate_latest_imaris(paths_to_check=None):
645645
"""Find paths to latest installed Imaris or ImarisFileConverter version.
646646
647+
Identify the full path to the most recent (as in "version number")
648+
ImarisFileConverter or Imaris installation folder with the latter one having
649+
priority. In case nothing is found, an empty string is returned.
650+
647651
Parameters
648652
----------
649653
paths_to_check: list of str, optional
@@ -653,11 +657,7 @@ def locate_latest_imaris(paths_to_check=None):
653657
Returns
654658
-------
655659
str
656-
Full path to the most recent (as in "version number") ImarisFileConverter
657-
or Imaris installation folder with the latter one having priority.
658-
Will be empty if nothing is found.
659660
"""
660-
661661
if not paths_to_check:
662662
paths_to_check = [
663663
r"C:\Program Files\Bitplane\ImarisFileConverter ",

0 commit comments

Comments
 (0)