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

Clean up zarr.core.metadata API #2642

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

dstansby
Copy link
Contributor

@dstansby dstansby commented Jan 4, 2025

Similar to other sub-modules in zarr.core, zarr.core.metadata imports some stuff into it's top level namespace. To stay consistent, I've:

  • Imported DataType here, because it's used in the code reprs.
  • Made zarr.core.metadata.{common, v2, v3} private

An alternative here would be to keep zarr.core.metadata.{common, v2, v3}, and move the documentation of classes currently defined in zarr.core.codecs back to their submodules. Thoughts?

@dstansby dstansby changed the title Clean up zarr.core.codecs api Clean up zarr.core.metadata api Jan 4, 2025
@dstansby dstansby changed the title Clean up zarr.core.metadata api Clean up zarr.core.metadata API Jan 4, 2025
@dstansby dstansby marked this pull request as ready for review January 4, 2025 09:59
@dstansby dstansby added this to the 3.0.0 milestone Jan 4, 2025
Copy link
Member

@normanrz normanrz left a comment

Choose a reason for hiding this comment

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

I like it!

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