Skip to content

Docs: Add detail on chunk manifest / chunk manifest shape#961

Merged
maxrjones merged 6 commits intozarr-developers:mainfrom
tylanderson:ta/docs-chunk-manifest-construct
Apr 20, 2026
Merged

Docs: Add detail on chunk manifest / chunk manifest shape#961
maxrjones merged 6 commits intozarr-developers:mainfrom
tylanderson:ta/docs-chunk-manifest-construct

Conversation

@tylanderson
Copy link
Copy Markdown
Contributor

What I did

Adding more detail on chunk manifests construction, and particularly on chunk grid shape, what it means and when to use it directly vs when it will be generated.

This was something that would have been helpful to have when creating the examples in #953

Acceptance criteria:

  • New functionality has documentation

Copy link
Copy Markdown
Member

@maxrjones maxrjones left a comment

Choose a reason for hiding this comment

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

Thanks @tylanderson! I think it'd be worth making these code blocks execute when the docs are built, to catch any errors. I've made a few suggestions to enable this. It looks great overall!

Comment thread docs/data_structures.md Outdated
Comment thread docs/data_structures.md Outdated
Comment thread docs/data_structures.md Outdated
Co-authored-by: Max Jones <14077947+maxrjones@users.noreply.github.com>
@maxrjones
Copy link
Copy Markdown
Member

@tylanderson I think you may have run into a GitHub bug in the code suggestion applications - it looks like the commit just removed the block quotes: a1e1871 (this PR)

@tylanderson
Copy link
Copy Markdown
Contributor Author

@tylanderson I think you may have run into a GitHub bug in the code suggestion applications - it looks like the commit just removed the block quotes: a1e1871 (this PR)

Yeah I noticed that, not sure why the batch suggestions dropped them, but should be fixed now

@maxrjones
Copy link
Copy Markdown
Member

maxrjones commented Apr 20, 2026

@tylanderson I think you may have run into a GitHub bug in the code suggestion applications - it looks like the commit just removed the block quotes: a1e1871 (this PR)

Yeah I noticed that, not sure why the batch suggestions dropped them, but should be fixed now

thanks

It looks like the execution flagged some errors in the examples, where ChunkManifest is not part of the top-level API: https://virtualizarr--961.org.readthedocs.build/en/961/data_structures.html#from-a-dictionary. This is intentional, because the developer API has less stability guarantees - https://virtualizarr--961.org.readthedocs.build/en/961/api/developer.html#virtualizarr.manifests.ChunkManifest.

Comment thread docs/data_structures.md Outdated
@maxrjones maxrjones merged commit 7a98c01 into zarr-developers:main Apr 20, 2026
5 checks passed
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.

2 participants