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

API docs #56

Merged
merged 8 commits into from
Mar 27, 2024
Merged

API docs #56

merged 8 commits into from
Mar 27, 2024

Conversation

TomNicholas
Copy link
Member

Cleans up and exposes a more useful and minimal subset of the API (so defining the public API).

Also changes some autodoc configuration to get everything to look nice with links and so on, basically just copying the way it was done in Cubed.

@TomNicholas TomNicholas added the documentation Improvements or additions to documentation label Mar 27, 2024
@TomNicholas
Copy link
Member Author

It would be nice to not have all the pydantic-specific methods on the ChunkManifest class be included in the API docs, but that can wait.

Copy link

codecov bot commented Mar 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.28%. Comparing base (7927fe3) to head (4a5a6aa).

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #56      +/-   ##
==========================================
+ Coverage   90.04%   90.28%   +0.24%     
==========================================
  Files          13       13              
  Lines         944      937       -7     
==========================================
- Hits          850      846       -4     
+ Misses         94       91       -3     
Flag Coverage Δ
unittests 90.28% <100.00%> (+0.24%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@TomNicholas TomNicholas merged commit db7116e into main Mar 27, 2024
8 checks passed
@TomNicholas TomNicholas deleted the api_docs branch March 27, 2024 19:26
@TomNicholas TomNicholas mentioned this pull request Mar 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant