Document crate topology (#2594) #2913
Conversation
| @@ -15,7 +15,7 @@ | |||
| // specific language governing permissions and limitations | |||
| // under the License. | |||
|
|
|||
| //! Buffer abstractions for [Apache Arrow](https://docs.rs/arrow) | |||
| //! Array data abstractions for [Apache Arrow](https://docs.rs/arrow) | |||
There was a problem hiding this comment.
Drive by fix for a copypasta
arrow/src/lib.rs
Outdated
| //! * [`arrow_buffer`] - buffer abstractions for arrow arrays | ||
| //! * [`arrow_schema`] - the logical types for arrow arrays | ||
| //! * [`arrow_data`] - the underlying data of arrow arrays | ||
| //! * [`arrow_array`] - type-safe arrow array abstractions | ||
| //! * [`arrow_select`] - selection kernels for arrow arrays |
There was a problem hiding this comment.
I had to alphabetize them to compare with https://github.com/apache/arrow-rs -- so figured it might help others
| //! * [`arrow_buffer`] - buffer abstractions for arrow arrays | |
| //! * [`arrow_schema`] - the logical types for arrow arrays | |
| //! * [`arrow_data`] - the underlying data of arrow arrays | |
| //! * [`arrow_array`] - type-safe arrow array abstractions | |
| //! * [`arrow_select`] - selection kernels for arrow arrays | |
| //! * [`arrow_array`] - type-safe arrow array abstractions | |
| //! * [`arrow_buffer`] - buffer abstractions for arrow arrays | |
| //! * [`arrow_data`] - the underlying data of arrow arrays | |
| //! * [`arrow_schema`] - the logical types for arrow arrays | |
| //! * [`arrow_select`] - selection kernels for arrow arrays |
There was a problem hiding this comment.
Would it also help to mention that some crates, such as arrow-flight are meant to be used by themselves (not as an implementation detail of arrow)?
arrow/src/lib.rs
Outdated
| //! # Columnar Format | ||
| //! | ||
| //! The [`array`] module provides statically typed implementations of all the array | ||
| //! types as defined by the [Arrow Columnar Format](https://arrow.apache.org/docs/format/Columnar.html). | ||
| //! [`arrow_array`] provides statically typed implementations of all the array types as defined |
There was a problem hiding this comment.
Given I think the above says the subcrates are re-exported as the public API I suggest keeping this example in terms of arrow (though updating the links to the arrow-array subcrate would be fine)
|
Benchmark runs are scheduled for baseline = 28d6152 and contender = bca8445. bca8445 is a master commit associated with this PR. Results will be available as each benchmark for each run completes. |
Which issue does this PR close?
Part of #2594
Rationale for this change
I found it non-trivial to find the documentation I wrote for managing arrow arrays, this is because the module docs were moved to the crate docs for arrow_array.
What changes are included in this PR?
Adds documentation on the crate topology, and updates links to reference these sub-crates
Are there any user-facing changes?
No, this just updates docs