Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Doxygen warnings in column header files #10963

Merged
merged 7 commits into from
Jun 5, 2022

Conversation

karthikeyann
Copy link
Contributor

Fixes parts of #9373
added missing documentation to fix doxygen warnings in column, column_view, column_device_view, column factories headers

fixes 155 warnings.

@karthikeyann karthikeyann added 3 - Ready for Review Ready for review by team doc Documentation libcudf Affects libcudf (C++/CUDA) code. 4 - Needs Review Waiting for reviewer to review or respond non-breaking Non-breaking change labels May 25, 2022
@karthikeyann karthikeyann requested a review from a team as a code owner May 25, 2022 12:02
@karthikeyann karthikeyann self-assigned this May 25, 2022
@karthikeyann karthikeyann requested a review from vyasr May 25, 2022 12:02
@karthikeyann karthikeyann requested a review from bdice May 25, 2022 12:02
@codecov
Copy link

codecov bot commented May 25, 2022

Codecov Report

❗ No coverage uploaded for pull request base (branch-22.08@6025f2b). Click here to learn what that means.
The diff coverage is n/a.

@@               Coverage Diff               @@
##             branch-22.08   #10963   +/-   ##
===============================================
  Coverage                ?   86.33%           
===============================================
  Files                   ?      144           
  Lines                   ?    22706           
  Branches                ?        0           
===============================================
  Hits                    ?    19604           
  Misses                  ?     3102           
  Partials                ?        0           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6025f2b...04d8701. Read the comment docs.

cpp/include/cudf/column/column.hpp Outdated Show resolved Hide resolved
cpp/include/cudf/column/column_device_view.cuh Outdated Show resolved Hide resolved
cpp/include/cudf/column/column_device_view.cuh Outdated Show resolved Hide resolved
cpp/include/cudf/column/column_device_view.cuh Outdated Show resolved Hide resolved
cpp/include/cudf/column/column_device_view.cuh Outdated Show resolved Hide resolved
cpp/include/cudf/column/column_device_view.cuh Outdated Show resolved Hide resolved
cpp/include/cudf/column/column_view.hpp Outdated Show resolved Hide resolved
cpp/include/cudf/column/column_view.hpp Outdated Show resolved Hide resolved
cpp/include/cudf/column/column_view.hpp Outdated Show resolved Hide resolved
@karthikeyann karthikeyann requested a review from vyasr May 28, 2022 00:22
@karthikeyann karthikeyann requested a review from a team June 2, 2022 01:06
Copy link
Contributor

@bdice bdice left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@karthikeyann Sorry for the delay in review. I started this review when you requested it and realized I hadn't submitted the review comments while cleaning my email inbox. Please find some suggestions attached. I am happy with any way you want to resolve the suggestions, so I am approving. I won't need to take another round of review unless you have questions. Thanks for your efforts on this!

*/
template <typename T>
static constexpr bool has_element_accessor()
{
return has_element_accessor_impl<column_device_view, T>::value;
}

/// Counting iterator
using count_it = thrust::counting_iterator<size_type>;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, this is a little awkward. We are defining a public member type count_it but it seems like this is only used for shorthand inside this class definition. The value typename column_device_view::count_it is never used. I wonder if this should be refactored in a separate PR.

It's normal to define iterator type members like const_iterator and iterator (for the mutable column device view) for containers, but count_it doesn't fit that category.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Likely, this type of fixes needs a global cleanup.

cpp/include/cudf/column/column_device_view.cuh Outdated Show resolved Hide resolved
cpp/include/cudf/column/column_device_view.cuh Outdated Show resolved Hide resolved
cpp/include/cudf/column/column_device_view.cuh Outdated Show resolved Hide resolved
cpp/include/cudf/column/column_factories.hpp Outdated Show resolved Hide resolved
cpp/include/cudf/column/column_view.hpp Outdated Show resolved Hide resolved
cpp/include/cudf/column/column_view.hpp Outdated Show resolved Hide resolved
cpp/include/cudf/column/column_view.hpp Outdated Show resolved Hide resolved
@karthikeyann
Copy link
Contributor Author

@gpucibot merge

@rapids-bot rapids-bot bot merged commit 840fc87 into rapidsai:branch-22.08 Jun 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3 - Ready for Review Ready for review by team 4 - Needs Review Waiting for reviewer to review or respond doc Documentation libcudf Affects libcudf (C++/CUDA) code. non-breaking Non-breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants