Skip to content

Commit

Permalink
chore: Update docs to refer to non deprecated function (partition) (#…
Browse files Browse the repository at this point in the history
…5027)

* chore: Update docs to refer to non deprecated function

* chore: Update docs to refer to non deprecated function
  • Loading branch information
alamb authored Nov 2, 2023
1 parent e4689e6 commit 1807aba
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions arrow-ord/src/partition.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 1807aba

Please sign in to comment.