Skip to content

Commit e6c66aa

Browse files
committed
fix docs
1 parent 7179a44 commit e6c66aa

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed

arrow/src/compute/kernels/comparison.rs

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1097,55 +1097,55 @@ macro_rules! typed_compares {
10971097
}};
10981098
}
10991099

1100-
/// Perform `left == right` operation on two (dynamic) arrays.
1100+
/// Perform `left == right` operation on two (dynamic) [`Array`]s.
11011101
///
11021102
/// Only when two arrays are of the same type the comparison will happen otherwise it will err
1103-
/// with a downcast_ref error.
1103+
/// with a casting error.
11041104
pub fn eq_dyn(left: &dyn Array, right: &dyn Array) -> Result<BooleanArray> {
11051105
typed_compares!(left, right, eq_bool, eq, eq_utf8)
11061106
}
11071107

1108-
/// Perform `left != right` operation on two (dynamic) arrays.
1108+
/// Perform `left != right` operation on two (dynamic) [`Array`]s.
11091109
///
11101110
/// Only when two arrays are of the same type the comparison will happen otherwise it will err
1111-
/// with a downcast_ref error.
1111+
/// with a casting error.
11121112
pub fn neq_dyn(left: &dyn Array, right: &dyn Array) -> Result<BooleanArray> {
11131113
typed_compares!(left, right, neq_bool, neq, neq_utf8)
11141114
}
11151115

1116-
/// Perform `left < right` operation on two (dynamic) arrays.
1116+
/// Perform `left < right` operation on two (dynamic) [`Array`]s.
11171117
///
11181118
/// Only when two arrays are of the same type the comparison will happen otherwise it will err
1119-
/// with a downcast_ref error.
1119+
/// with a casting error.
11201120
pub fn lt_dyn(left: &dyn Array, right: &dyn Array) -> Result<BooleanArray> {
11211121
typed_compares!(left, right, lt, lt_utf8)
11221122
}
11231123

1124-
/// Perform `left <= right` operation on two (dynamic) arrays.
1124+
/// Perform `left <= right` operation on two (dynamic) [`Array`]s.
11251125
///
11261126
/// Only when two arrays are of the same type the comparison will happen otherwise it will err
1127-
/// with a downcast_ref error.
1127+
/// with a casting error.
11281128
pub fn lt_eq_dyn(left: &dyn Array, right: &dyn Array) -> Result<BooleanArray> {
11291129
typed_compares!(left, right, lt_eq, lt_eq_utf8)
11301130
}
11311131

1132-
/// Perform `left > right` operation on two (dynamic) arrays.
1132+
/// Perform `left > right` operation on two (dynamic) [`Array`]s.
11331133
///
11341134
/// Only when two arrays are of the same type the comparison will happen otherwise it will err
1135-
/// with a downcast_ref error.
1135+
/// with a casting error.
11361136
pub fn gt_dyn(left: &dyn Array, right: &dyn Array) -> Result<BooleanArray> {
11371137
typed_compares!(left, right, gt, gt_utf8)
11381138
}
11391139

1140-
/// Perform `left >= right` operation on two (dynamic) arrays.
1140+
/// Perform `left >= right` operation on two (dynamic) [`Array`]s.
11411141
///
11421142
/// Only when two arrays are of the same type the comparison will happen otherwise it will err
1143-
/// with a downcast_ref error.
1143+
/// with a casting error.
11441144
pub fn gt_eq_dyn(left: &dyn Array, right: &dyn Array) -> Result<BooleanArray> {
11451145
typed_compares!(left, right, gt_eq, gt_eq_utf8)
11461146
}
11471147

1148-
/// Perform `left == right` operation on two primitive arrays.
1148+
/// Perform `left == right` operation on two [`PrimitiveArray`]s.
11491149
pub fn eq<T>(left: &PrimitiveArray<T>, right: &PrimitiveArray<T>) -> Result<BooleanArray>
11501150
where
11511151
T: ArrowNumericType,
@@ -1156,7 +1156,7 @@ where
11561156
return compare_op!(left, right, |a, b| a == b);
11571157
}
11581158

1159-
/// Perform `left == right` operation on an array and a scalar value.
1159+
/// Perform `left == right` operation on a [`PrimitiveArray`] and a scalar value.
11601160
pub fn eq_scalar<T>(left: &PrimitiveArray<T>, right: T::Native) -> Result<BooleanArray>
11611161
where
11621162
T: ArrowNumericType,
@@ -1167,7 +1167,7 @@ where
11671167
return compare_op_scalar!(left, right, |a, b| a == b);
11681168
}
11691169

1170-
/// Perform `left != right` operation on two arrays.
1170+
/// Perform `left != right` operation on two [`PrimitiveArray`]s.
11711171
pub fn neq<T>(left: &PrimitiveArray<T>, right: &PrimitiveArray<T>) -> Result<BooleanArray>
11721172
where
11731173
T: ArrowNumericType,
@@ -1178,7 +1178,7 @@ where
11781178
return compare_op!(left, right, |a, b| a != b);
11791179
}
11801180

1181-
/// Perform `left != right` operation on an array and a scalar value.
1181+
/// Perform `left != right` operation on a [`PrimitiveArray`] and a scalar value.
11821182
pub fn neq_scalar<T>(left: &PrimitiveArray<T>, right: T::Native) -> Result<BooleanArray>
11831183
where
11841184
T: ArrowNumericType,
@@ -1189,7 +1189,7 @@ where
11891189
return compare_op_scalar!(left, right, |a, b| a != b);
11901190
}
11911191

1192-
/// Perform `left < right` operation on two arrays. Null values are less than non-null
1192+
/// Perform `left < right` operation on two [`PrimitiveArray`]s. Null values are less than non-null
11931193
/// values.
11941194
pub fn lt<T>(left: &PrimitiveArray<T>, right: &PrimitiveArray<T>) -> Result<BooleanArray>
11951195
where
@@ -1201,7 +1201,7 @@ where
12011201
return compare_op!(left, right, |a, b| a < b);
12021202
}
12031203

1204-
/// Perform `left < right` operation on an array and a scalar value.
1204+
/// Perform `left < right` operation on a [`PrimitiveArray`] and a scalar value.
12051205
/// Null values are less than non-null values.
12061206
pub fn lt_scalar<T>(left: &PrimitiveArray<T>, right: T::Native) -> Result<BooleanArray>
12071207
where
@@ -1213,7 +1213,7 @@ where
12131213
return compare_op_scalar!(left, right, |a, b| a < b);
12141214
}
12151215

1216-
/// Perform `left <= right` operation on two arrays. Null values are less than non-null
1216+
/// Perform `left <= right` operation on two [`PrimitiveArray`]s. Null values are less than non-null
12171217
/// values.
12181218
pub fn lt_eq<T>(
12191219
left: &PrimitiveArray<T>,
@@ -1228,7 +1228,7 @@ where
12281228
return compare_op!(left, right, |a, b| a <= b);
12291229
}
12301230

1231-
/// Perform `left <= right` operation on an array and a scalar value.
1231+
/// Perform `left <= right` operation on a [`PrimitiveArray`] and a scalar value.
12321232
/// Null values are less than non-null values.
12331233
pub fn lt_eq_scalar<T>(left: &PrimitiveArray<T>, right: T::Native) -> Result<BooleanArray>
12341234
where
@@ -1240,7 +1240,7 @@ where
12401240
return compare_op_scalar!(left, right, |a, b| a <= b);
12411241
}
12421242

1243-
/// Perform `left > right` operation on two arrays. Non-null values are greater than null
1243+
/// Perform `left > right` operation on two [`PrimitiveArray`]s. Non-null values are greater than null
12441244
/// values.
12451245
pub fn gt<T>(left: &PrimitiveArray<T>, right: &PrimitiveArray<T>) -> Result<BooleanArray>
12461246
where
@@ -1252,7 +1252,7 @@ where
12521252
return compare_op!(left, right, |a, b| a > b);
12531253
}
12541254

1255-
/// Perform `left > right` operation on an array and a scalar value.
1255+
/// Perform `left > right` operation on a [`PrimitiveArray`] and a scalar value.
12561256
/// Non-null values are greater than null values.
12571257
pub fn gt_scalar<T>(left: &PrimitiveArray<T>, right: T::Native) -> Result<BooleanArray>
12581258
where
@@ -1264,7 +1264,7 @@ where
12641264
return compare_op_scalar!(left, right, |a, b| a > b);
12651265
}
12661266

1267-
/// Perform `left >= right` operation on two arrays. Non-null values are greater than null
1267+
/// Perform `left >= right` operation on two [`PrimitiveArray`]s. Non-null values are greater than null
12681268
/// values.
12691269
pub fn gt_eq<T>(
12701270
left: &PrimitiveArray<T>,
@@ -1279,7 +1279,7 @@ where
12791279
return compare_op!(left, right, |a, b| a >= b);
12801280
}
12811281

1282-
/// Perform `left >= right` operation on an array and a scalar value.
1282+
/// Perform `left >= right` operation on a [`PrimitiveArray`] and a scalar value.
12831283
/// Non-null values are greater than null values.
12841284
pub fn gt_eq_scalar<T>(left: &PrimitiveArray<T>, right: T::Native) -> Result<BooleanArray>
12851285
where

0 commit comments

Comments
 (0)