Skip to content

Conversation

K-Meech
Copy link
Contributor

@K-Meech K-Meech commented Sep 22, 2025

Closes #3303

Documents valid values of StoreLike in the user guide, and links to this common location from docstrings. This fixes inconsistencies with how StoreLike is described, see corresponding issue. This is based on the handling of StoreLike by zarr.storage._common.make_store.

To link from the docstrings, I had to enable the autoref plugin which is recommended in the mkdocstrings documentation. I added a unique markdown anchor for this section in the user guide #user-guide-store-like to ensure all links go to the correct location. Without this (using the auto-generated heading links alone), would mean that any other doc using a 'StoreLike' heading would break these links.

I added examples for all the different values except: dict[str, Buffer] and FSMap. Happy to add examples to this PR if people have suggestions.

TODO:

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/user-guide/*.md
  • Changes documented as a new file in changes/
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

@d-v-b
Copy link
Contributor

d-v-b commented Sep 22, 2025

thanks @K-Meech!

@d-v-b d-v-b enabled auto-merge (squash) September 22, 2025 22:00
@d-v-b d-v-b merged commit 45756b0 into zarr-developers:main Sep 22, 2025
29 of 49 checks passed
Copy link

codecov bot commented Sep 22, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 61.21%. Comparing base (2d3d790) to head (9b97467).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3480      +/-   ##
==========================================
+ Coverage   61.18%   61.21%   +0.03%     
==========================================
  Files          84       84              
  Lines        9923     9923              
==========================================
+ Hits         6071     6074       +3     
+ Misses       3852     3849       -3     
Files with missing lines Coverage Δ
src/zarr/api/asynchronous.py 72.20% <ø> (ø)
src/zarr/api/synchronous.py 36.61% <ø> (ø)
src/zarr/core/array.py 68.62% <ø> (ø)
src/zarr/core/group.py 70.24% <ø> (ø)
src/zarr/storage/_common.py 67.00% <ø> (ø)

... and 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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.

Better document acceptable values for StoreLike
2 participants