bioio-devs / bioio

Image reading, metadata management, and image writing for Microscopy images in Python
https://bioio-devs.github.io/bioio/OVERVIEW.html
BSD 3-Clause "New" or "Revised" License
58 stars 4 forks source link

Update ome_tiff_writer.py to remove reference to `image_names` #74

Closed TimMonko closed 2 months ago

TimMonko commented 2 months ago

Link to Relevant Issue

This pull request resolves #

Description of Changes

Documentation suggests that argument is image_names instead of image_name. Using OmeTiffWriter.save(image_names=[str]) silently saves the data without saving the argument to the ome metadata. This fixes updates the documentation so users instead use OmeTiffWriter.save(image_name=[str]) to avoid this issue.