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 links to numcodecs docs in tutorial #1535

Merged
merged 3 commits into from
Oct 31, 2023

Conversation

dstansby
Copy link
Contributor

@dstansby dstansby commented Oct 1, 2023

This adds links through to the numcodecs docs where classes are mentioned in the tutorial section of the docs.

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)

@github-actions github-actions bot added the needs release notes Automatically applied to PRs which haven't added release notes label Oct 1, 2023
@joshmoore
Copy link
Member

This is great, @dstansby. Thanks! I'm re-opening to see if I can get the builds to pass.

@joshmoore joshmoore closed this Oct 31, 2023
@joshmoore joshmoore reopened this Oct 31, 2023
@joshmoore
Copy link
Member

🎉 Thoughts on listing this under docs/release.rst?

@github-actions github-actions bot removed the needs release notes Automatically applied to PRs which haven't added release notes label Oct 31, 2023
@joshmoore joshmoore merged commit cce501a into zarr-developers:main Oct 31, 2023
21 checks passed
@dstansby dstansby deleted the numcodec-links branch October 31, 2023 11:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants