Repository navigation
docs: use in-memory stores for examples that don't demonstrate disk storage - #4289
CAOShurong wants to merge 7 commits into
Conversation
|
🤖 AI text below 🤖 Code reviewFound 4 issues:
zarr-python/docs/user-guide/cli.md Lines 64 to 68 in ccea1c4
zarr-python/docs/quick-start.md Lines 44 to 46 in ccea1c4
zarr-python/docs/user-guide/performance.md Lines 321 to 328 in ccea1c4
Minor (below confidence threshold): the new cleanup before the groups.md 🤖 Generated with Claude Code - If this code review was useful, please react with 👍. Otherwise, react with 👎. |
ccea1c4 to
b7c0821
Compare
|
Follow-up fixes pushed in
Verified with the relevant documentation examples ( |
|
The single failing required-matrix job is unrelated to this docs-only diff: |
…torage (zarr-developers#3681) Resolves zarr-developers#3681. Documentation examples that are not specifically demonstrating local/remote persistence wrote arrays to the local data/ directory at docs-build time (~20 arrays across quick-start and the user guide). Switch non-persistence demos to in-memory stores (memory:// URLs / MemoryStore / empty-dict stores) so the build no longer litter artifacts on disk, and convert the persistent-storage demos to clean up their own scratch directories instead of relying on a single global rmtree at the top of quick-start. Verified with tests/test_docs.py (61 passed, 2 skipped — cupy/s3 markers). Co-Authored-By: Claude <noreply@anthropic.com>
b7c0821 to
585adff
Compare
|
@CAOShurong this requires some changes but the direction is right. do you mind if I push some additions? |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4289 +/- ##
=======================================
Coverage 94.71% 94.71%
=======================================
Files 94 94
Lines 13663 13663
=======================================
Hits 12941 12941
Misses 722 722 🚀 New features to boost your workflow:
|
Use fresh stores for in-memory examples and owned temporary directories for persistence examples. Close ZIP stores before cleaning up their directory.
Description
Resolves #3681.
Documentation examples that are not specifically demonstrating local/remote
persistence were writing arrays to the local
data/directory at docs-buildtime (the issue estimates ~20 arrays across
quick-startand the user guide).This PR:
artifacts on disk.
directories.
quick-start.mdprose that claimed the opening examples used aLocalStore(they now use in-memory stores).storage.md, the LocalStore/ZipStore sections ofquick-start.md, and thecreate_hierarchydemo ingroups.mdareintentionally left on-disk since they demonstrate file/disk backends.
Type of change
Checklist
changes/4289.doc.md).Verification
Full arrays session and strict MkDocs build: NOT_RUN.
🤖 Generated with Claude Code