Skip to content

docs: clarify difference between load and open in docstrings#3984

Open
SAY-5 wants to merge 3 commits into
zarr-developers:mainfrom
SAY-5:docs/document-load-vs-open
Open

docs: clarify difference between load and open in docstrings#3984
SAY-5 wants to merge 3 commits into
zarr-developers:mainfrom
SAY-5:docs/document-load-vs-open

Conversation

@SAY-5
Copy link
Copy Markdown

@SAY-5 SAY-5 commented May 19, 2026

Closes #463. Adds Notes and See Also cross-references to the load and open docstrings explaining that load eagerly reads data into in-memory NumPy arrays while open returns a lazy Array/Group backed by the store, addressing the maintainer's note that "the documentation could definitely be improved here, PR welcome."

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)

@codecov
Copy link
Copy Markdown

codecov Bot commented May 19, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.34%. Comparing base (7afdc8d) to head (4a16523).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3984   +/-   ##
=======================================
  Coverage   93.34%   93.34%           
=======================================
  Files          88       88           
  Lines       11819    11819           
=======================================
  Hits        11033    11033           
  Misses        786      786           
Files with missing lines Coverage Δ
src/zarr/api/asynchronous.py 94.05% <ø> (ø)
src/zarr/api/synchronous.py 92.95% <ø> (ø)
🚀 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.

Documenting the difference between load and open

1 participant