Docs: Add detail on chunk manifest / chunk manifest shape#961
Conversation
maxrjones
left a comment
There was a problem hiding this comment.
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!
Co-authored-by: Max Jones <14077947+maxrjones@users.noreply.github.com>
|
@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: |
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. |
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: