Skip to content

Commit

Permalink
Improve aggregation documentation (#16822)
Browse files Browse the repository at this point in the history
This PR fixes several documentation issues uncovered while working on #16619. There are no actual code changes.

Authors:
  - Yunsong Wang (https://github.com/PointKernel)

Approvers:
  - David Wendt (https://github.com/davidwendt)
  - Mark Harris (https://github.com/harrism)

URL: #16822
  • Loading branch information
PointKernel committed Sep 19, 2024
1 parent dafb3e7 commit 8782a1d
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions cpp/include/cudf/detail/aggregation/aggregation.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -1497,8 +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
* 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.
*/
Expand Down Expand Up @@ -1626,6 +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` function object.
* @param args Parameter pack forwarded to the `operator()` invocation
* `F`.
*/
Expand All @@ -1644,8 +1644,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 kind
* @return data_type The target_type of k performed on source_type
* elements
*/
Expand Down

0 comments on commit 8782a1d

Please sign in to comment.