[GitHub] [arrow-rs] tustvold commented on a diff in pull request #4197: Update docs (#4071)

["tustvold (via GitHub)" <gi...@apache.org>]

tustvold commented on code in PR #4197:
URL: https://github.com/apache/arrow-rs/pull/4197#discussion_r1190220421


##########
arrow-array/src/lib.rs:
##########
@@ -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

Review Comment:
   This content is moved later



##########
arrow/src/lib.rs:
##########
@@ -317,19 +317,6 @@
 //! assert_eq!(string.value(1), "foo");
 //! ```
 //!
-//! # Memory and Buffers

Review Comment:
   This section is outdated and documenting it at this level just adds confusion, lets leave that for the arrow_array docs



##########
arrow-array/src/lib.rs:
##########
@@ -91,63 +55,114 @@
 //!
 //! // Append a single primitive value
 //! builder.append_value(1);
-//!
 //! // Append a null value
 //! builder.append_null();
-//!
 //! // Append a slice of primitive values
 //! builder.append_slice(&[2, 3, 4]);
 //!
 //! // Build the array
 //! let array = builder.finish();
 //!
-//! assert_eq!(
-//!     5,
-//!     array.len(),
-//!     "The array has 5 values, counting the null value"
-//! );
+//! assert_eq!(5, array.len());
+//! assert_eq!(2, array.value(2));
+//! assert_eq!(&array.values()[3..5], &[3, 4])
+//! ```
 //!
-//! assert_eq!(2, array.value(2), "Get the value with index 2");
+//! # Low-level API

Review Comment:
   This reworks the internal representation section, taking some inspiration from https://jorgecarleitao.github.io/arrow2/main/guide/low_level.html



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org