Skip to content

Commit 1db636a

Browse files
committed
Update comments to reflect new function
1 parent 0c0a2da commit 1db636a

1 file changed

Lines changed: 6 additions & 9 deletions

File tree

‎datafusion/physical-expr/src/sort_expr.rs‎

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -80,23 +80,20 @@ impl PhysicalSortExpr {
8080

8181
/// Represents sort requirement associated with a plan
8282
///
83-
/// If the requirement is *exact*
84-
/// ([`PhysicalSortRequirement::new_exact`]), then the sort
85-
/// requirement will only be satisfied if it matches both the
86-
/// expression *and* the sort options.
83+
/// If the requirement incudes [`SortOptions`] then both the
84+
/// expression *and* the sort options must match.
8785
///
88-
/// If the requirement is *`expr_only`
89-
/// ([`PhysicalSortRequirement::new_expr_only`]) then only the expr
90-
/// must match, to satisfy the requirement.
86+
/// If the requirement does not include [`SortOptions`]) then only the
87+
/// expressions must match.
9188
///
9289
/// # Examples
9390
///
94-
/// Given an `exact` sort requirement of (`A`, `DESC NULLS FIRST`):
91+
/// With sort options (`A`, `DESC NULLS FIRST`):
9592
/// * `ORDER BY A DESC NULLS FIRST` matches
9693
/// * `ORDER BY A ASC NULLS FIRST` does not match (`ASC` vs `DESC`)
9794
/// * `ORDER BY B DESC NULLS FIRST` does not match (different expr)
9895
///
99-
/// Given an `expr_only` sort requirement of (`A`, None):
96+
/// Without sort options (`A`, None):
10097
/// * `ORDER BY A DESC NULLS FIRST` matches
10198
/// * `ORDER BY A ASC NULLS FIRST` matches (`ASC` and `NULL` options ignored)
10299
/// * `ORDER BY B DESC NULLS FIRST` does not match (different expr)

0 commit comments

Comments
 (0)