docs: use in-memory stores for examples that don't demonstrate disk storage - #4289
docs: use in-memory stores for examples that don't demonstrate disk storage#4289CAOShurong wants to merge 2 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 👎. |
…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>
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: |
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:
memory://URLs /MemoryStore()/ empty-dict stores) so the build no longer littersartifacts on disk.
directories instead of relying on a single global
shutil.rmtree('data')at the top of
quick-start.md(which also silently masked aZipStoreparent-dir bug — the zip demos now createdata/explicitly).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_hierarchy(store=LocalStore(root='data'))demo ingroups.mdareintentionally left on-disk since they demonstrate file/disk backends.
Type of change
Checklist
changes/3682.doc.md).Verification
tests/test_docs.pyexecutes everyexec="true"/test="true"block:The 2 skips are pre-existing environment markers (
cupyGPU example and adocstring example that imports a nonexistent module) and are unrelated to
this change.
🤖 Generated with Claude Code