Rename xarray-zarr source and add docs#723
Merged
Merged
Conversation
Oisin-M
reviewed
Jun 13, 2025
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #723 +/- ##
========================================
Coverage 90.70% 90.70%
========================================
Files 170 170
Lines 12936 12936
Branches 616 616
========================================
Hits 11733 11733
Misses 1015 1015
Partials 188 188 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR renames the
xarray-zarrsource tozarr. Also adds documentation.The reason behind the renaming:
The name "xarray-zarr" reflects the fact that the Zarr store is read by Xarray internally. The suggestion is to use a more generic name "zarr". In the future if another Zarr reader is added e.g. based on the Zarr API we could handle it with an extra kwarg in
from_source(). E.g.Also consider that none of the existing source names contains/refers to the reader.