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 1807abace4 chore: Update docs to refer to non deprecated function
(`partition`) (#5027)
1807abace4 is described below
commit 1807abace4153cbfd287ee830f86ebaeeae50234
Author: Andrew Lamb <[email protected]>
AuthorDate: Thu Nov 2 11:28:47 2023 -0400
chore: Update docs to refer to non deprecated function (`partition`) (#5027)
* chore: Update docs to refer to non deprecated function
* chore: Update docs to refer to non deprecated function
---
arrow-ord/src/partition.rs | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/arrow-ord/src/partition.rs b/arrow-ord/src/partition.rs
index 12ab8dba04..8c87eefadb 100644
--- a/arrow-ord/src/partition.rs
+++ b/arrow-ord/src/partition.rs
@@ -78,7 +78,7 @@ impl Partitions {
/// # Example:
///
/// For example, given columns `x`, `y` and `z`, calling
-/// `lexicographical_partition_ranges(values, (x, y))` will divide the
+/// [`partition`]`(values, (x, y))` will divide the
/// rows into ranges where the values of `(x, y)` are equal:
///
/// ```text
@@ -160,8 +160,9 @@ fn find_boundaries(v: &dyn Array) -> Result<BooleanBuffer,
ArrowError> {
Ok(distinct(&v1, &v2)?.values().clone())
}
-/// Given a list of already sorted columns, find partition ranges that would
partition
-/// lexicographically equal values across columns.
+/// Use [`partition`] instead. Given a list of already sorted columns, find
+/// partition ranges that would partition lexicographically equal values across
+/// columns.
///
/// The returned vec would be of size k where k is cardinality of the sorted
values; Consecutive
/// values will be connected: (a, b) and (b, c), where start = 0 and end = n
for the first and last
