From 6efa4601fbf2194b8d9e9451af1376c230086529 Mon Sep 17 00:00:00 2001 From: yjhmelody <465402634@qq.com> Date: Fri, 8 Oct 2021 13:56:40 +0800 Subject: [PATCH] update docs --- src/compute/arithmetics/basic/add.rs | 2 +- src/compute/arithmetics/basic/mul.rs | 7 +++---- src/compute/arithmetics/basic/sub.rs | 7 +++---- 3 files changed, 7 insertions(+), 9 deletions(-) diff --git a/src/compute/arithmetics/basic/add.rs b/src/compute/arithmetics/basic/add.rs index 72c4c1a4ece..73bf1420a4a 100644 --- a/src/compute/arithmetics/basic/add.rs +++ b/src/compute/arithmetics/basic/add.rs @@ -43,7 +43,7 @@ where binary(lhs, rhs, lhs.data_type().clone(), |a, b| a + b) } -/// Wrapping addition of two `PrimitiveArray`s. +/// Wrapping addition of two [`PrimitiveArray`]s. /// It wraps around at the boundary of the type if the result overflows. /// /// # Examples diff --git a/src/compute/arithmetics/basic/mul.rs b/src/compute/arithmetics/basic/mul.rs index 5179ab326c2..101442947d3 100644 --- a/src/compute/arithmetics/basic/mul.rs +++ b/src/compute/arithmetics/basic/mul.rs @@ -43,8 +43,8 @@ where binary(lhs, rhs, lhs.data_type().clone(), |a, b| a * b) } -/// Wrapping multiplication of two primitive arrays. -/// It do nothing if the result overflows. +/// Wrapping multiplication of two [`PrimitiveArray`]s. +/// It wraps around at the boundary of the type if the result overflows. /// /// # Examples /// ``` @@ -168,7 +168,6 @@ where } } -// Implementation of ArrayWrappingMul trait for PrimitiveArrays impl ArrayWrappingMul> for PrimitiveArray where T: NativeType + WrappingMul + NotI128, @@ -236,7 +235,7 @@ where unary(lhs, |a| a * rhs, lhs.data_type().clone()) } -/// Wrapping multiplication of a scalar T to a primitive array of type T. +/// Wrapping multiplication of a scalar T to a [`PrimitiveArray`] of type T. /// It do nothing if the result overflows. /// /// # Examples diff --git a/src/compute/arithmetics/basic/sub.rs b/src/compute/arithmetics/basic/sub.rs index 10f6484cf87..eaefed35f1b 100644 --- a/src/compute/arithmetics/basic/sub.rs +++ b/src/compute/arithmetics/basic/sub.rs @@ -43,8 +43,8 @@ where binary(lhs, rhs, lhs.data_type().clone(), |a, b| a - b) } -/// Wrapping subtraction of two primitive arrays. -/// It do nothing if the result overflows. +/// Wrapping subtraction of two [`PrimitiveArray`]s. +/// It wraps around at the boundary of the type if the result overflows. /// /// # Examples /// ``` @@ -167,7 +167,6 @@ where } } -// Implementation of ArrayWrappingSub trait for PrimitiveArrays impl ArrayWrappingSub> for PrimitiveArray where T: NativeType + WrappingSub + NotI128, @@ -236,7 +235,7 @@ where unary(lhs, |a| a - rhs, lhs.data_type().clone()) } -/// Wrapping subtraction of a scalar T to a primitive array of type T. +/// Wrapping subtraction of a scalar T to a [`PrimitiveArray`] of type T. /// It do nothing if the result overflows. /// /// # Examples