Skip to content

Commit

Permalink
Fix verb/subject agreement.
Browse files Browse the repository at this point in the history
  • Loading branch information
bdice committed Apr 12, 2024
1 parent fce091f commit cafdf6f
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions cpp/include/cudf/utilities/type_checks.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
namespace cudf {

/**
* @brief Compares the type of two `column_view`s
* @brief Compare the types of two `column_view`s
*
* @deprecated Since 24.06. Use cudf::have_same_types instead.
*
Expand Down Expand Up @@ -68,56 +68,56 @@ namespace cudf {
*
* @param lhs The first `column_view` to compare
* @param rhs The second `column_view` to compare
* @return true if column types match
* @return true if types match
*/
bool have_same_types(column_view const& lhs, column_view const& rhs);

/**
* @brief Compares the type of a `column_view` and a `scalar`
* @brief Compare the types of a `column_view` and a `scalar`
*
* This function returns true if the type of `lhs` equals that of `rhs`.
* - For fixed point types, the scale is compared.
* - For dictionary column types, the type of the keys are compared to the
* - For dictionary column types, the type of the keys is compared to the
* scalar type.
* - For lists types, the type of child columns are compared recursively.
* - For struct types, the type of each field are compared in order.
* - For lists types, the types of child columns are compared recursively.
* - For struct types, the types of each field are compared in order.
* - For all other types, the `id` of `data_type` is compared.
*
* @param lhs The `column_view` to compare
* @param rhs The `scalar` to compare
* @return true if column/scalar types match
* @return true if types match
*/
bool have_same_types(column_view const& lhs, scalar const& rhs);

/**
* @brief Compares the type of a `scalar` and a `column_view`
* @brief Compare the types of a `scalar` and a `column_view`
*
* This function returns true if the type of `lhs` equals that of `rhs`.
* - For fixed point types, the scale is compared.
* - For dictionary column types, the type of the keys are compared to the
* - For dictionary column types, the type of the keys is compared to the
* scalar type.
* - For lists types, the type of child columns are compared recursively.
* - For struct types, the type of each field are compared in order.
* - For lists types, the types of child columns are compared recursively.
* - For struct types, the types of each field are compared in order.
* - For all other types, the `id` of `data_type` is compared.
*
* @param lhs The `scalar` to compare
* @param rhs The `column_view` to compare
* @return true if column/scalar types match
* @return true if types match
*/
bool have_same_types(scalar const& lhs, column_view const& rhs);

/**
* @brief Compares the type of two `scalar`s
* @brief Compare the types of two `scalar`s
*
* This function returns true if the type of `lhs` equals that of `rhs`.
* - For fixed point types, the scale is compared.
* - For lists types, the type of child columns are compared recursively.
* - For struct types, the type of each field are compared in order.
* - For lists types, the types of child columns are compared recursively.
* - For struct types, the types of each field are compared in order.
* - For all other types, the `id` of `data_type` is compared.
*
* @param lhs The first `scalar` to compare
* @param rhs The second `scalar` to compare
* @return true if scalar types match
* @return true if types match
*/
bool have_same_types(scalar const& lhs, scalar const& rhs);

Expand Down

0 comments on commit cafdf6f

Please sign in to comment.