Skip to content

Commit ac1e860

Browse files
committed
fix(run_imarisconvert): clarify output folder behavior
- Update docstring to specify that if no output folder is provided, the IMS file will be saved in the same directory as the input file.
1 parent 08d9976 commit ac1e860

1 file changed

Lines changed: 2 additions & 3 deletions

File tree

src/imcflibs/imagej/misc.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -684,12 +684,11 @@ def run_imarisconvert(file_path, pixel_calibration=None, output_folder=""):
684684
Sequence of 3 values (x, y, z) representing voxel dimensions to be set during
685685
conversion, by default None.
686686
output_folder : str, optional
687-
Folder where the newly created IMS file will be saved, by default None.
687+
Folder where the newly created IMS file will be saved, by default None
688+
which will result in the output file being saved in the same directory as the input file.
688689
689690
Notes
690691
-----
691-
- If `output_folder` is not provided (or is empty), the converted `.ims`
692-
file will be written to the same directory as the input file.
693692
- The output filename is constructed by taking the input filename and
694693
replacing its extension with `.ims` (for example,
695694
`/path/to/image.czi` -> `/path/to/image.ims`).

0 commit comments

Comments
 (0)