This is an automated email from the ASF dual-hosted git repository.
alamb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow-rs.git
The following commit(s) were added to refs/heads/master by this push:
new b46115b Add links in docstrings (#605)
b46115b is described below
commit b46115b0ade9cd911771995ba39402a80557ec73
Author: Andrew Lamb <[email protected]>
AuthorDate: Thu Jul 29 15:29:37 2021 -0400
Add links in docstrings (#605)
---
arrow/src/array/array_binary.rs | 2 ++
arrow/src/array/array_list.rs | 2 ++
arrow/src/array/array_string.rs | 3 +++
3 files changed, 7 insertions(+)
diff --git a/arrow/src/array/array_binary.rs b/arrow/src/array/array_binary.rs
index 66bfb79..a88fb2c 100644
--- a/arrow/src/array/array_binary.rs
+++ b/arrow/src/array/array_binary.rs
@@ -42,6 +42,8 @@ impl BinaryOffsetSizeTrait for i64 {
const DATA_TYPE: DataType = DataType::LargeBinary;
}
+/// See [`BinaryArray`] and [`LargeBinaryArray`] for storing
+/// binary data.
pub struct GenericBinaryArray<OffsetSize: BinaryOffsetSizeTrait> {
data: ArrayData,
value_offsets: RawPtrBox<OffsetSize>,
diff --git a/arrow/src/array/array_list.rs b/arrow/src/array/array_list.rs
index 94f87bb..0489271 100644
--- a/arrow/src/array/array_list.rs
+++ b/arrow/src/array/array_list.rs
@@ -341,6 +341,8 @@ pub type LargeListArray = GenericListArray<i64>;
/// A list array where each element is a fixed-size sequence of values with
the same
/// type whose maximum length is represented by a i32.
+///
+/// For non generic lists, you may wish to consider using
[`FixedSizeBinaryArray`]
pub struct FixedSizeListArray {
data: ArrayData,
values: ArrayRef,
diff --git a/arrow/src/array/array_string.rs b/arrow/src/array/array_string.rs
index 93e1337..0b48e57 100644
--- a/arrow/src/array/array_string.rs
+++ b/arrow/src/array/array_string.rs
@@ -42,6 +42,9 @@ impl StringOffsetSizeTrait for i64 {
}
/// Generic struct for \[Large\]StringArray
+///
+/// See [`StringArray`] and [`LargeStringArray`] for storing
+/// specific string data.
pub struct GenericStringArray<OffsetSize: StringOffsetSizeTrait> {
data: ArrayData,
value_offsets: RawPtrBox<OffsetSize>,
