Minimal docs for vortex-btrblocks #4730
Merged
Conversation
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
Signed-off-by: Adam Gutglick <adam@spiraldb.com>
joseph-isaacs
approved these changes
Sep 23, 2025
Contributor
|
Can we now require doc strs on this crate? |
Codecov Report✅ All modified and coverable lines are covered by tests. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
gatesn
reviewed
Sep 23, 2025
Contributor
gatesn
left a comment
gatesn
left a comment
There was a problem hiding this comment.
Wanna go the extra mile and add deny_missing_docs?
Signed-off-by: Adam Gutglick <adam@spiraldb.com>
Contributor
Author
|
added a bunch of docs, and reduced the public API a bit. I think we might want to make it even smaller and/or make the compressor more configurable/modular. |
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.
No description provided.