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

dep(docs): deprecate experimental v3 support in docs #1807

Merged
merged 2 commits into from
Apr 30, 2024

Conversation

jhamman
Copy link
Member

@jhamman jhamman commented Apr 22, 2024

Follow up to #1802 adding warnings to the docs about the pending deprecation of experimental v3 code path.

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/tutorial.rst
  • Changes documented in docs/release.rst
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

@jhamman jhamman added the V3 Related to compatibility with V3 spec label Apr 22, 2024
@jhamman jhamman added this to the 2.18.0 milestone Apr 22, 2024
@jhamman jhamman requested review from joshmoore and d-v-b April 22, 2024 21:20
docs/release.rst Outdated Show resolved Hide resolved
Copy link
Member

@joshmoore joshmoore left a comment

Choose a reason for hiding this comment

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

One minor change, otherwise 👍

docs/api/v3.rst Outdated Show resolved Hide resolved
Co-authored-by: Josh Moore <josh@openmicroscopy.org>
Co-authored-by: Sanket Verma <svsanketverma5@gmail.com>
Copy link

codecov bot commented Apr 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.98%. Comparing base (9d046ea) to head (ae499d8).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1807      +/-   ##
==========================================
- Coverage   99.98%   99.98%   -0.01%     
==========================================
  Files          38       38              
  Lines       14659    14656       -3     
==========================================
- Hits        14657    14654       -3     
  Misses          2        2              
Files Coverage Δ
zarr/convenience.py 100.00% <ø> (ø)

... and 2 files with indirect coverage changes

@jhamman jhamman merged commit 29b4acc into zarr-developers:main Apr 30, 2024
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
V3 Related to compatibility with V3 spec
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants