Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Update docs to refer to non deprecated function (partition) #5027

Merged
merged 2 commits into from
Nov 2, 2023
Merged

chore: Update docs to refer to non deprecated function (partition) #5027

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f8b10ff
chore: Update docs to refer to non deprecated function
alamb Nov 2, 2023
b13fcae
chore: Update docs to refer to non deprecated function
alamb Nov 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions arrow-ord/src/partition.rs
View file
Open in desktop
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