Update arrow rustdocs (#4071) #4197
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
tustvold
added
documentation
tustvold
commented
May 10, 2023
| @@ -19,50 +19,14 @@ | |||
| //! all having the same type. This crate provides concrete implementations of each type, as | |||
| //! well as an [`Array`] trait that can be used for type-erasure. | |||
| //! | |||
| //! # Downcasting an Array | |||
There was a problem hiding this comment.
This content is moved later
| //! | ||
| //! assert_eq!(2, array.value(2), "Get the value with index 2"); | ||
| //! # Low-level API |
There was a problem hiding this comment.
This reworks the internal representation section, taking some inspiration from https://jorgecarleitao.github.io/arrow2/main/guide/low_level.html
| @@ -317,19 +317,6 @@ | |||
| //! assert_eq!(string.value(1), "foo"); | |||
| //! ``` | |||
| //! | |||
| //! # Memory and Buffers | |||
There was a problem hiding this comment.
This section is outdated and documenting it at this level just adds confusion, lets leave that for the arrow_array docs
alamb
reviewed
May 10, 2023
| @@ -25,7 +25,7 @@ use arrow_schema::{ArrowError, DataType}; | |||
| use std::any::Any; | |||
| use std::sync::Arc; | |||
|
|
|||
| /// An array where each element is a fixed-size sequence of bytes. | |||
| /// An array of [fixed size binary arrays](https://arrow.apache.org/docs/format/Columnar.html#fixed-size-primitive-layout) | |||
There was a problem hiding this comment.
the link to primitive arrays seems strange for fixed size binary, but I looked around on the docs and I didn't see any better section 🤷
There was a problem hiding this comment.
I reviewed the content in this module in its rendered form:
Love it
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.
Which issue does this PR close?
Part of #4071
Rationale for this change
The current docs are out of date following #4061, and the output for some is pretty hard to parse
This updates the docs so that the type summaries are a single line and sufficiently descriptive, and adds some new content about array buffers.
What changes are included in this PR?
Are there any user-facing changes?