Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update ReadMe and Change Log #73

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Conversation

dgault
Copy link
Member

@dgault dgault commented Dec 14, 2023

I have updated the ReadMe to remove the outdated TODO section and add documentation for the new reader options. I have also added a link to the release on artifactory

The change log has also been updated to included missing entries from previous releases

Fixes #72

Copy link
Member

@will-moore will-moore left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good 👍

@will-moore
Copy link
Member

I remember it was mentioned that we should highlight the one change in behaviour that users might notice: labels are not now considered as separate images. I guess this maybe falls into docs rather than changelog (along with the new bfoptions documentation)?

@dgault
Copy link
Member Author

dgault commented Dec 15, 2023

Yeah, that is a good point. I have added some additional description for that particular setting to note the change in behaviour

@will-moore
Copy link
Member

Am I right in thinking that the way ZarrReader looks for .bfoptions is different from other readers?
ZarrReader looks for file.zarr.bfoptions as a sibling beside the file.zarr directory, whereas other readers look for e.g. file.tiff.bfoptions beside the file that is passed to setId.
I don't know if that distinction should be made in this repo docs or at https://bio-formats.readthedocs.io/en/latest/formats/options.html#usage

Looking at that page, I don't see that either of these methods is mentioned for specifying bfoptions?

@dgault
Copy link
Member Author

dgault commented Jan 9, 2024

Yeah, that is a good point, I will update the readme to include some details on the bfoptions file usage

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

OMEZarrReader.jar download link to artifactory
3 participants