docs: fix docstring for Array.cdata_shape#3768
Merged
maxrjones merged 3 commits intozarr-developers:mainfrom Mar 12, 2026
Merged
docs: fix docstring for Array.cdata_shape#3768maxrjones merged 3 commits intozarr-developers:mainfrom
maxrjones merged 3 commits intozarr-developers:mainfrom
Conversation
Member
Author
|
Or maybe this was just a bug? It's confusing why there's a .chunks and a .cdata_shape. |
Contributor
|
cdata_shape is from zarr python 2.x |
d-v-b
approved these changes
Mar 12, 2026
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.
The
cdata_shapedocstring states that it returns the shape of the chunk grid. However, Zarr-Python's internals use the chunk grid to model the outer boundaries (xref #3767). This changes the docstring to align with the implementation, which returns a shape for inner chunks.This also applies to the function named
_chunk_grid_shape. I updated that docstring but chose not to rename to something more technically accurate.TODO:
docs/user-guide/*.mdchanges/