Skip to content

Conversation

@maxrjones
Copy link
Member

This PR reduces the number of redirects needed by maintaining the same API documentation structure that used for sphinx.

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 Nov 19, 2025
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.

looks good to me, do you want @ilan-gold to check this as well?

@maxrjones maxrjones marked this pull request as draft November 19, 2025 17:18
@maxrjones
Copy link
Member Author

looks good to me, do you want @ilan-gold to check this as well?

I need to make a couple more changes, I just temporarily converted this to a draft and will ping you both when they're done. I got a bit side-tracked by zarr-developers/zarr-specs#367, but should have this ready shortly

@maxrjones maxrjones marked this pull request as ready for review November 19, 2025 20:12
@maxrjones
Copy link
Member Author

@d-v-b @ilan-gold I think this is ready now. It reverts some opinionated structural changes to the API documentation, to minimize the differences between 3.1.3 and 3.1.4. I think one review, rather than two, would be sufficient for this PR.

@maxrjones
Copy link
Member Author

@d-v-b what's the norm in zarr-python - do I re-request a review after the last commit or just use the existing approval and merge?

@d-v-b
Copy link
Contributor

d-v-b commented Nov 20, 2025

my old approval is still good I think :) i will merge, thanks for this @maxrjones

@d-v-b d-v-b merged commit 8eb244f into zarr-developers:main Nov 20, 2025
31 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.

2 participants