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

Automatically document Array members #1547

Merged
merged 3 commits into from
Nov 24, 2023
Merged

Conversation

dstansby
Copy link
Contributor

@dstansby dstansby commented Oct 25, 2023

This PR uses the automodapi sphinx extension to automatically document members of the Array class. Previously these were manually listed, meaning they have to be manually updated every time the actual method or property is updated in the code. Now they are autogenerated.

Fixes #1546

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 25, 2023
@d-v-b
Copy link
Contributor

d-v-b commented Oct 25, 2023

this is great, thank you!

@dstansby
Copy link
Contributor Author

dstansby commented Oct 25, 2023

Hmm, it seems like the link to the Array class is broken in the doc build: https://zarr--1547.org.readthedocs.build/en/1547/api/core.html - I'll take a look and try and fix.

@codecov
Copy link

codecov bot commented Oct 25, 2023

Codecov Report

Merging #1547 (5ca3c93) into main (8a7b415) will decrease coverage by 0.01%.
The diff coverage is 100.00%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1547      +/-   ##
==========================================
- Coverage   99.99%   99.99%   -0.01%     
==========================================
  Files          37       37              
  Lines       14740    14737       -3     
==========================================
- Hits        14739    14736       -3     
  Misses          1        1              
Files Coverage Δ
zarr/core.py 100.00% <100.00%> (ø)

... and 3 files with indirect coverage changes

@dstansby dstansby marked this pull request as draft October 31, 2023 10:49
@dstansby dstansby marked this pull request as ready for review November 14, 2023 15:36
@dstansby
Copy link
Contributor Author

@joshmoore
Copy link
Member

Wow. Nice, @dstansby! Even got rid of a few items that were incorrectly listed! (compression, compression_opts, dimension_separator). Thanks again.

@joshmoore joshmoore merged commit 74764af into zarr-developers:main Nov 24, 2023
21 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.

Array class doc contains attributes that don't exist
3 participants