Repository navigation
#29 - Update documentation to reflect what is being returned by the API - #47
Merged
reckart merged 1 commit intoAug 1, 2026
Conversation
- Document that download methods (`annotation`, `document`, `curation`) return raw bytes that may be ZIP archives for multi-file formats, with runtime sniffing guidance - Consolidate ZIP-handling examples to single canonical section in formats documentation with working code and performance notes - Condense `:return:` docstrings in adapter interface to defer to documentation instead of hard-coding format examples
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #47 +/- ##
=======================================
Coverage 95.68% 95.68%
=======================================
Files 20 20
Lines 696 696
Branches 44 44
=======================================
Hits 666 666
Misses 19 19
Partials 11 11 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
reckart
deleted the
feature/29-Update-documentation-to-reflect-what-is-being-returned-by-the-API
branch
August 1, 2026 13:53
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What's in the PR
annotation,document,curation) return raw bytes that may be ZIP archives for multi-file formats, with runtime sniffing guidance:return:docstrings in adapter interface to defer to documentation instead of hard-coding format examplesHow to test manually
Automatic testing
Documentation