Skip to content

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!

@dstansby dstansby marked this pull request as draft January 6, 2025 16:15
@jhamman
Copy link
Member

jhamman commented Jan 8, 2025

@dstansby - do you have thoughts on how to proceed here given #2669?

I'd be happy to see this land today but I don't think it needs to block 3.0.0.

@jhamman jhamman modified the milestones: 3.0.0, After 3.0.0 Jan 8, 2025
@dstansby
Copy link
Contributor Author

dstansby commented Jan 9, 2025

👍 doesn't need to block 3.0.0, and needs updating, but would be good to keep it open to remind me to update it at some point

@dstansby dstansby added the needs release notes Automatically applied to PRs which haven't added release notes label Jan 9, 2025
@dstansby dstansby closed this Apr 29, 2025
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.

3 participants