Skip to content

Conversation

dstansby
Copy link
Contributor

I noticed that the documentation build allows warnings through - these can include things like broken links, broken RST, or duplicate references. I've enabled the -W flag by default in the makefile so these get caught, and fixed the few existing warnings.

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)

@d-v-b
Copy link
Contributor

d-v-b commented Oct 25, 2023

Looks good to me! I think we need some release notes.

@joshmoore
Copy link
Member

Thanks!

@joshmoore joshmoore merged commit c9532b0 into zarr-developers:main Oct 31, 2023
@dstansby dstansby deleted the doc-warnings branch October 31, 2023 12:29
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.

3 participants