Skip to content
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.

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

Add API reference for V3 Implementation in the docs #1345

Merged
merged 8 commits into from Mar 17, 2023

Conversation

MSanKeys963
Copy link
Member

@MSanKeys963 MSanKeys963 commented Feb 9, 2023

Hi all. I've added the API reference for V3 implementation in the docs. This issue was raised in the community meeting on 2/8 this week.

Linking this from #1337. Preview available here: https://zarr--1345.org.readthedocs.build/en/1345/api/v3.html

Let me know what you think. Suggestions welcome.

CC: @joshmoore @grlee77 @jstriebel

TODO:

  • Changes documented in docs/release.rst
  • 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 Feb 9, 2023
@joshmoore
Copy link
Member

Thanks, @MSanKeys963! I imagine @ivirshup will want to take a look. I'll add here that @jstriebel was skeptical about getting this released with ZEP1 still in-flight, but this PR will at least give us a place to start prepping the docs.

docs/api/v3.rst Outdated Show resolved Hide resolved
docs/api/v3.rst Show resolved Hide resolved
MSanKeys963 and others added 2 commits February 15, 2023 05:12
Co-authored-by: Jonathan Striebel <jstriebel@users.noreply.github.com>
Co-authored-by: Jonathan Striebel <jstriebel@users.noreply.github.com>
@codecov
Copy link

codecov bot commented Feb 14, 2023

Codecov Report

Merging #1345 (b17b17a) into main (280d969) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##              main     #1345   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           36        36           
  Lines        14748     14803   +55     
=========================================
+ Hits         14748     14803   +55     

see 8 files with indirect coverage changes

@joshmoore
Copy link
Member

Shall I roll this into 2.15?

docs/api/v3.rst Outdated Show resolved Hide resolved
docs/api/v3.rst Outdated Show resolved Hide resolved
MSanKeys963 and others added 2 commits March 10, 2023 21:10
Co-authored-by: Jonathan Striebel <jstriebel@users.noreply.github.com>
@MSanKeys963
Copy link
Member Author

Shall I roll this into 2.15?

We're good. @jstriebel, please let me know if you want me to add a separate page for sharding or if you'd like to do it. Thanks!

@joshmoore
Copy link
Member

Hearing from @MSanKeys963 that @jstriebel is happy with this, I'm going to get it merged. Thanks all!

@joshmoore joshmoore merged commit 2ff8875 into zarr-developers:main Mar 17, 2023
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs release notes Automatically applied to PRs which haven't added release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants