Skip to content

Add experimental section to the API docs #3642

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
maxrjones merged 3 commits into from
Jan 8, 2026
Merged

Add experimental section to the API docs #3642

maxrjones merged 3 commits into from
Jan 8, 2026
+20 −7

Conversation

@maxrjones
Copy link
Member

@maxrjones maxrjones commented Jan 7, 2026

Adding this so that people can see the function signature for the experimental CacheStore.

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)

@github-actions github-actions bot added the needs release notes Automatically applied to PRs which haven't added release notes label Jan 7, 2026
d-v-b
d-v-b reviewed Jan 8, 2026
View reviewed changes
docs/user-guide/experimental.md

**max_size**: Controls the maximum size of cached data in bytes

```python exec="true" session="experimental" source="above" result="ansi"
Copy link
Contributor

@d-v-b d-v-b Jan 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What effect does this change have?

Copy link
Member Author

@maxrjones maxrjones Jan 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please see #3645, in short it makes it so there's no empty cell shown below

d-v-b
d-v-b approved these changes Jan 8, 2026
View reviewed changes
Copy link
Contributor

@d-v-b d-v-b left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks max!

@maxrjones maxrjones mentioned this pull request Jan 8, 2026
Merged
6 tasks
@maxrjones maxrjones enabled auto-merge (squash) January 8, 2026 17:48
@maxrjones maxrjones merged commit 87d2041 into zarr-developers:main Jan 8, 2026
29 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@d-v-b d-v-b d-v-b approved these changes

Assignees

No one assigned

Labels

needs release notes Automatically applied to PRs which haven't added release notes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@maxrjones @d-v-b