search

fmicompbio / ez_zarr

GIve easy, high-level access to ome-zarr fileset
https://fmicompbio.github.io/ez_zarr/
MIT License
13 stars 0 forks source link

Various documentation fixes #7

Closed csoneson closed 5 months ago

csoneson commented 6 months ago

This PR contains some small suggestions to improve the clarity and consistency of the documentation (and some typo fixes). Please let me know if there is anything else that should be done/rendered locally from these files before pushing, that I may have missed.

codecov-commenter commented 6 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (0fa2895) 100.00% compared to head (4dd81b0) 100.00%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #7 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 4 4 Lines 976 976 ========================================= Hits 976 976 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

silvbarb commented 6 months ago

Looks great to me, Thanks Charlotte!

The only thing I am not sure is which convention we want to stick to when it comes to '.zarr', as this is the file extension of the OME-Zarr produced by fractal (and we do not have .zarrs, but multiple .zarr files). What do you think?

csoneson commented 6 months ago

Yeah, not sure - one option could be to put the .zarr in fixed-width case and then add the s, i.e. .zarrs (I've sometimes done this when referring to data.frames etc.)