enforce docstrings in vortex-buffer #575
Merged
Conversation
This file contains 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
a10y
force-pushed
the
aduffy/docstrings-1
branch
from
0d7adde
to
f5bbffa
Compare
lwwmanning
reviewed
Aug 8, 2024
vortex-buffer/src/lib.rs
Outdated
| //! | ||
| //! # Alignment | ||
| //! | ||
| //! We do not currently enforce any alignment guarantees on the buffer. This can be problematic |
There was a problem hiding this comment.
Maybe worth linking #115 re: alignment in case this comment goes stale. Also, the recommendation to convert to Arrow doesn't really help, since it accepts arbitrarily aligned vecs? (only enforces alignment for things it allocates)
vortex-buffer/src/lib.rs
Outdated
| @@ -8,31 +20,40 @@ mod flexbuffers; | |||
| pub mod io_buf; | |||
| mod string; | |||
|
|
|||
| /// Buffer is an owned, cheaply cloneable byte arrays. | |||
lwwmanning
approved these changes
Aug 8, 2024
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.
Part of #574