From ed571dabcce3a85c0f3adcd16f16b1142a21fbcc Mon Sep 17 00:00:00 2001 From: Yunsong Wang Date: Tue, 17 Sep 2024 15:27:20 -0700 Subject: [PATCH 1/2] Improve aggregation documentation --- cpp/include/cudf/detail/aggregation/aggregation.hpp | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/cpp/include/cudf/detail/aggregation/aggregation.hpp b/cpp/include/cudf/detail/aggregation/aggregation.hpp index b257eef1e9e..78d9951670d 100644 --- a/cpp/include/cudf/detail/aggregation/aggregation.hpp +++ b/cpp/include/cudf/detail/aggregation/aggregation.hpp @@ -1497,7 +1497,7 @@ AGG_KIND_MAPPING(aggregation::VARIANCE, var_aggregation); * * @tparam F Type of callable * @param k The `aggregation::Kind` value to dispatch - * aram f The callable that accepts an `aggregation::Kind` non-type template + * @param f The callable that accepts an `aggregation::Kind` non-type template * argument. * @param args Parameter pack forwarded to the `operator()` invocation * @return Forwards the return value of the callable. @@ -1626,6 +1626,8 @@ struct dispatch_source { * parameter of the callable `F` * @param k The `aggregation::Kind` used to dispatch an `aggregation::Kind` * non-type template parameter for the second template parameter of the callable + * @param f The callable that accepts `data_type` and `aggregation::Kind` non-type template + * arguments. * @param args Parameter pack forwarded to the `operator()` invocation * `F`. */ @@ -1644,8 +1646,8 @@ CUDF_HOST_DEVICE inline constexpr decltype(auto) dispatch_type_and_aggregation(d * @brief Returns the target `data_type` for the specified aggregation k * performed on elements of type source_type. * - * aram source_type The element type to be aggregated - * aram k The aggregation + * @param source_type The element type to be aggregated + * @param k The aggregation * @return data_type The target_type of k performed on source_type * elements */ From b604ae390ab555d70c29c7e7be1776e78a2636b0 Mon Sep 17 00:00:00 2001 From: Yunsong Wang Date: Wed, 18 Sep 2024 13:13:31 -0700 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Mark Harris <783069+harrism@users.noreply.github.com> --- cpp/include/cudf/detail/aggregation/aggregation.hpp | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/cpp/include/cudf/detail/aggregation/aggregation.hpp b/cpp/include/cudf/detail/aggregation/aggregation.hpp index 78d9951670d..4255faea702 100644 --- a/cpp/include/cudf/detail/aggregation/aggregation.hpp +++ b/cpp/include/cudf/detail/aggregation/aggregation.hpp @@ -1497,8 +1497,7 @@ AGG_KIND_MAPPING(aggregation::VARIANCE, var_aggregation); * * @tparam F Type of callable * @param k The `aggregation::Kind` value to dispatch - * @param f The callable that accepts an `aggregation::Kind` non-type template - * argument. + * @param f The callable that accepts an `aggregation::Kind` callable function object. * @param args Parameter pack forwarded to the `operator()` invocation * @return Forwards the return value of the callable. */ @@ -1626,8 +1625,7 @@ struct dispatch_source { * parameter of the callable `F` * @param k The `aggregation::Kind` used to dispatch an `aggregation::Kind` * non-type template parameter for the second template parameter of the callable - * @param f The callable that accepts `data_type` and `aggregation::Kind` non-type template - * arguments. + * @param f The callable that accepts `data_type` and `aggregation::Kind` function object. * @param args Parameter pack forwarded to the `operator()` invocation * `F`. */ @@ -1647,7 +1645,7 @@ CUDF_HOST_DEVICE inline constexpr decltype(auto) dispatch_type_and_aggregation(d * performed on elements of type source_type. * * @param source_type The element type to be aggregated - * @param k The aggregation + * @param k The aggregation kind * @return data_type The target_type of k performed on source_type * elements */