[arrow-rs] branch master updated: Tweak row format docs (#3191)

[tu...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

tustvold 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 cbe5af071 Tweak row format docs (#3191)
cbe5af071 is described below

commit cbe5af071ce68b2a36d9e9881767ebd95bfdac83
Author: Raphael Taylor-Davies <17...@users.noreply.github.com>
AuthorDate: Fri Nov 25 12:52:44 2022 +0000

    Tweak row format docs (#3191)
---
 arrow/src/row/mod.rs | 21 +++++++++------------
 1 file changed, 9 insertions(+), 12 deletions(-)

diff --git a/arrow/src/row/mod.rs b/arrow/src/row/mod.rs
index 4f48b46cb..21d8e4df0 100644
--- a/arrow/src/row/mod.rs
+++ b/arrow/src/row/mod.rs
@@ -17,19 +17,13 @@
 
 //! A comparable row-oriented representation of a collection of [`Array`].
 //!
-//! [`Row`]s are [normalized for sorting], and can be very efficiently [compared],
-//! using [`memcmp`] under the hood, or used in [non-comparison sorts] such as [radix sort]. This
-//! makes the row format ideal for implementing efficient multi-column sorting,
-//! grouping, aggregation, windowing and more.
+//! [`Row`]s are [normalized for sorting], and can therefore be very efficiently [compared],
+//! using [`memcmp`] under the hood, or used in [non-comparison sorts] such as [radix sort].
+//! This makes the row format ideal for implementing efficient multi-column sorting,
+//! grouping, aggregation, windowing and more, as described in more detail
+//! [here](https://arrow.apache.org/blog/2022/11/07/multi-column-sorts-in-arrow-rust-part-1/).
 //!
-//! The format is described in more detail on [`RowConverter`] as well as the
-//! [Fast and Memory Efficient Multi-Column Sorts in Apache Arrow Rust](https://arrow.apache.org/blog/2022/11/07/multi-column-sorts-in-arrow-rust-part-1/) article.
-//!
-//! _[`Rows`] generated by different [`RowConverter`] are arbitrarily
-//! ordered. The same [`RowConverter`] must be used for the comparison
-//! to be well defined._
-//!
-//! For example, given three input [`Array`]s, this code creates byte
+//! For example, given three input [`Array`], [`RowConverter`] creates byte
 //! sequences that [compare] the same as when using [`lexsort`].
 //!
 //! ```text
@@ -50,6 +44,9 @@
 //!     (Columns)
 //! ```
 //!
+//! _[`Rows`] must be generated by the same [`RowConverter`] for the comparison
+//! to be meaningful._
+//!
 //! # Basic Example
 //! ```
 //! # use std::sync::Arc;