Skip to content

Conversation

@jhamman
Copy link
Member

@jhamman jhamman commented Jan 7, 2025

Closes #2621

@jhamman jhamman requested review from dstansby and normanrz January 7, 2025 23:39
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.

👍 overall. There's a couple of places in the docs where we reference stuff in zarr.core in public docs though, which need fixing:

This breaks a link in the config guide:

:mod:`zarr.config <zarr.core.config>` is responsible for managing the configuration of zarr and

Looking lower down the config user guide, several of the objects referenced in the default config are from the zarr.core namespace, so they should either be added back to the API documentation, or moved eleswhere in the API so we're not giving users references to API that we're considering private.

zarr.core.group.ConsolidatedMetadata is also publicly facing according to the consolidated metdata guide, so that needs making public in the docs too.

@jhamman
Copy link
Member Author

jhamman commented Jan 8, 2025

I don't think we have time today to do a proper fix to the consolidated metadata class but I'll fix the config link now.

@jhamman
Copy link
Member Author

jhamman commented Jan 8, 2025

I think this is as far as we should take it right now. Follow up actions could include:

  • Move zarr.core.buffer.cpu to a public place (maybe even numcodecs)
  • Move zarr.core.codec_pipeline.BatchedCodecPipeline to a public place

Since both of these are quite advanced parts of Zarr, I'm not too concerned about moving these after 3.0.0.

@jhamman jhamman merged commit bc26199 into zarr-developers:main Jan 8, 2025
28 checks passed
@jhamman jhamman deleted the api/private-core branch January 8, 2025 17:22
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.

Make zarr.core private

3 participants