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: Add store import changes to v3 migration guide (fix #2733) #2883

Merged
merged 3 commits into from
Mar 4, 2025

Conversation

OPMTerra
Copy link
Contributor

@OPMTerra OPMTerra commented Mar 3, 2025

My first contribution addressing #2733! This PR adds documentation to clarify store import changes in the v3 migration guide.

What's Included

  • Clear comparison table showing v2 vs v3 imports for MemoryStore/DirectoryStore
  • Example using tempfile.TemporaryDirectory for TempStore migration
  • Fixed formatting in the migration guide based on build feedback

Checklist (For Maintainers)

✅ Docs updated in user-guide/v3_migration.rst
✅ No code changes needed (pure documentation)
✅ Built docs locally to verify formatting

This helps users like those in imagecodecs#123 who encountered build errors with old imports. While it doesn't fix external projects directly, it:

  1. Shows proper v3 import paths
  2. Explains replacements for deprecated stores
  3. Provides copy-paste examples for common migrations

I'm happy to make any adjustments needed!
@OPMTerra

@github-actions github-actions bot added the needs release notes Automatically applied to PRs which haven't added release notes label Mar 3, 2025
Copy link
Contributor

@dstansby dstansby left a comment

Choose a reason for hiding this comment

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

This is a great addition! My one suggestion before merging is to change the heading level so the new heading appears under "The Store class" level.

Adjust heading level per review feedback

Co-authored-by: David Stansby <[email protected]>
@dstansby dstansby enabled auto-merge (squash) March 4, 2025 14:34
@OPMTerra
Copy link
Contributor Author

OPMTerra commented Mar 4, 2025

Hi @dstansby 👋,

I've adjusted the heading level as suggested. Let me know if anything else needs tweaking!

Thank you for the review! 🙏

@dstansby dstansby merged commit 73d5a6c into zarr-developers:main Mar 4, 2025
29 of 30 checks passed
@OPMTerra OPMTerra deleted the doc/2733-store-imports branch March 4, 2025 14:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs release notes Automatically applied to PRs which haven't added release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants