More docs #1104
Merged
More docs #1104
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
robert3005
reviewed
Oct 21, 2024
robert3005
approved these changes
Oct 21, 2024
lwwmanning
reviewed
Oct 21, 2024
| @@ -21,6 +21,10 @@ pub trait ArrayDef { | |||
| type Encoding: ArrayEncoding + ArrayEncodingExt<D = Self>; | |||
| } | |||
|
|
|||
| /// Macro to generate all the necessary code for a new type of array encoding. Including: | |||
| /// 1. New Array type that implements `AsRef<Array>`, `GetArrayMetadata`, `ToArray`, `IntoArray`, and multiple useful `From`/`TryFrom` implementations. | |||
| /// 1. New Encoding type that implements `ArrayEncoding`. | |||
There was a problem hiding this comment.
Markdown auto-generates the right numbers
There was a problem hiding this comment.
+ makes it easier to re-order/add more points (checked both VSCode and rustdoc renders it correctly)
|
Just a couple minor typos |
a10y
reviewed
Oct 21, 2024
| @@ -131,6 +131,7 @@ pub fn infer_schema(dtype: &DType) -> VortexResult<Schema> { | |||
| Ok(builder.finish()) | |||
| } | |||
|
|
|||
| /// Try to convert a Vortex [`DType`] into an a Arrow [`DataType`] | |||
There was a problem hiding this comment.
Suggested change
| /// Try to convert a Vortex [`DType`] into an a Arrow [`DataType`] | |
| /// Try to convert a Vortex [`DType`] into an Arrow [`DataType`] |
| @@ -62,9 +61,14 @@ pub mod flatbuffers { | |||
| pub use vortex_flatbuffers::array::*; | |||
| } | |||
|
|
|||
| /// A central type for all Vortex arrays, which are known length sequences of compressed data. | |||
There was a problem hiding this comment.
Suggested change
| /// A central type for all Vortex arrays, which are known length sequences of compressed data. | |
| /// A central type for all Vortex arrays, which are known length sequences of typed and possibly compressed data |
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.
More docs, trying to cleanup some of the main rustdoc page.