Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Top-level Store removal not in v3 migration guide #2733

Closed
QuLogic opened this issue Jan 20, 2025 · 4 comments
Closed

DOC: Top-level Store removal not in v3 migration guide #2733

QuLogic opened this issue Jan 20, 2025 · 4 comments
Labels
documentation Improvements to the documentation help wanted Issue could use help from someone with familiarity on the topic

Comments

@QuLogic
Copy link
Contributor

QuLogic commented Jan 20, 2025

Describe the issue linked to the documentation

I've found that imagecodecs fails to build with Zarr 3 cgohlke/imagecodecs#123 due to their use of zarr.MemoryStore.

While I linked to the migration guide, a search through it does not have any mention of MemoryStore. I think they should be using zarr.storage.MemoryStore instead, but there's no note there and I don't know if that was available in v2 or not.

Suggested fix for documentation

All zarr.*Store removals should be mentioned in the v3 migration guide along with their replacements.

@QuLogic QuLogic added documentation Improvements to the documentation help wanted Issue could use help from someone with familiarity on the topic labels Jan 20, 2025
@d-v-b
Copy link
Contributor

d-v-b commented Jan 20, 2025

thanks for the report, and sorry for the inconvenience caused here. we should definitely update the guide as you suggest

@OPMTerra
Copy link
Contributor

OPMTerra commented Mar 3, 2025

Hi @d-v-b @QuLogic 👋,

I’d like to help document the store import changes for #2733. If this is not assigned to anyone.

Plan:

  • Add a "Store Imports" section to the v3 migration guide
  • List replacements like MemoryStore → zarr.storage.MemoryStore
  • Include code snippets for v2 vs v3

Is this the right approach?

@d-v-b
Copy link
Contributor

d-v-b commented Mar 3, 2025

@OPMTerra that sounds great, thanks for your help!

@OPMTerra
Copy link
Contributor

OPMTerra commented Mar 3, 2025

Hi @d-v-b @QuLogic 👋,

My PR #2883 is ready for review!

Changes made:

  • Added a table comparing v2/v3 store imports (MemoryStore, DirectoryStore, TempStore)
  • Included code examples for migrating from deprecated imports
  • Fixed formatting issues flagged during docs build

This should help users avoid confusion like in imagecodecs#123 by clearly showing the new import paths.

Let me know if any adjustments are needed!
Thank you for the guidance! 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements to the documentation help wanted Issue could use help from someone with familiarity on the topic
Projects
None yet
Development

No branches or pull requests

3 participants