zarr-python icon indicating copy to clipboard operation
zarr-python copied to clipboard

doc: tutorial updates for 3.0

Open jhamman opened this issue 1 year ago • 1 comments

This is a work in progress. Running through the tutorial helped identify a number of issues that we likely want to address before we release 3.0.

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 avatar Oct 18 '24 19:10 jhamman

Woop woop! In case you don't know about it already, https://github.com/scientific-python/pytest-doctestplus?tab=readme-ov-file#fixing-existing-docstrings might be helpful

dstansby avatar Oct 18 '24 21:10 dstansby

closing in favor of #2589

jhamman avatar Dec 30 '24 02:12 jhamman