Closed davidwendt closed 4 years ago
Here is a picture of the modules page with the proposed groupings.
Clicking on a group will show just the functions for that group.
I think we can get even more consistency in the naming... we just need to decide if we like the gerund ("ing") names used in many libcudf headers. I like it -- it is consistent with Thrust documentation, and to some extent STL documentation. e.g. partitioning. Wonder if we should use "grouping" instead of "GroupBy".
Also, are two-word group names allowed? If so, then "Unary Operations", and "Binary Operations", not "UnaryOps".
Proposal to organize libcudf column APIs documentation into doxygen groups that can be displayed on the generated Modules page. Using the
@*group
tags in the comments can generate an organized page of common functions. Proposal is to use the currentinclude/cudf
external API headers to organize into groups.These can be subgroups of a
Columns API
as well. This should make it easier to locate documentation without scrolling through the entire cudf namespace page.