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 structs, lists headers #10923

Merged
merged 9 commits into from
Jun 1, 2022

Conversation

karthikeyann
Copy link
Contributor

@karthikeyann karthikeyann commented May 22, 2022

Fixes parts of #9373
added missing documentation to fix doxygen warnings in structs/*.hpp and lists/*.hpp
fixes 67 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 22, 2022
@karthikeyann karthikeyann requested a review from a team as a code owner May 22, 2022 12:36
@karthikeyann karthikeyann self-assigned this May 22, 2022
@karthikeyann karthikeyann requested a review from vyasr May 22, 2022 12:36
@karthikeyann karthikeyann requested a review from davidwendt May 22, 2022 12:36
@karthikeyann karthikeyann changed the title add missing docs to structs, lists headers fix doxygen warnings in structs, lists headers May 22, 2022
Copy link
Contributor

@davidwendt davidwendt left a comment

Choose a reason for hiding this comment

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

Looks good. Thanks for doing this.

cpp/include/cudf/lists/lists_column_view.hpp Outdated Show resolved Hide resolved
cpp/include/cudf/structs/structs_column_device_view.cuh Outdated Show resolved Hide resolved
cpp/include/cudf/lists/lists_column_device_view.cuh Outdated Show resolved Hide resolved
cpp/include/cudf/lists/lists_column_device_view.cuh Outdated Show resolved Hide resolved
cpp/include/cudf/lists/list_device_view.cuh Outdated Show resolved Hide resolved
cpp/include/cudf/lists/list_device_view.cuh Outdated Show resolved Hide resolved
cpp/include/cudf/lists/list_device_view.cuh Outdated Show resolved Hide resolved
cpp/include/cudf/lists/list_device_view.cuh Outdated Show resolved Hide resolved
cpp/include/cudf/lists/list_device_view.cuh Outdated Show resolved Hide resolved
cpp/include/cudf/lists/list_device_view.cuh Outdated Show resolved Hide resolved
@karthikeyann karthikeyann requested a review from davidwendt May 24, 2022 19:35
@karthikeyann
Copy link
Contributor Author

@davidwendt Thank you for detailed review! Updated other files too with all comments.

@karthikeyann karthikeyann changed the title fix doxygen warnings in structs, lists headers Fix doxygen warnings in structs, lists headers May 24, 2022
Copy link
Contributor

@davidwendt davidwendt left a comment

Choose a reason for hiding this comment

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

I would recommend undo-ing changes to files where you are only removing '.'
I don't think this is worth fixing/reviewing.

cpp/include/cudf/lists/detail/gather.cuh Outdated Show resolved Hide resolved
cpp/include/cudf/lists/gather.hpp Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented May 24, 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   #10923   +/-   ##
===============================================
  Coverage                ?   86.32%           
===============================================
  Files                   ?      144           
  Lines                   ?    22696           
  Branches                ?        0           
===============================================
  Hits                    ?    19593           
  Misses                  ?     3103           
  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...f99147e. Read the comment docs.

@karthikeyann
Copy link
Contributor Author

@davidwendt reverted those changes and addressed review comments.

@karthikeyann karthikeyann requested a review from davidwendt May 25, 2022 07:25
@karthikeyann karthikeyann requested a review from a team May 25, 2022 07:26
cpp/include/cudf/lists/list_device_view.cuh Outdated Show resolved Hide resolved
cpp/include/cudf/lists/list_device_view.cuh Outdated Show resolved Hide resolved
cpp/include/cudf/lists/list_device_view.cuh Outdated Show resolved Hide resolved
cpp/include/cudf/lists/list_device_view.cuh Outdated Show resolved Hide resolved
cpp/include/cudf/lists/list_device_view.cuh Outdated Show resolved Hide resolved
cpp/include/cudf/lists/list_device_view.cuh Outdated Show resolved Hide resolved
cpp/include/cudf/lists/list_device_view.cuh Outdated Show resolved Hide resolved
cpp/include/cudf/lists/list_device_view.cuh Outdated Show resolved Hide resolved
cpp/include/cudf/lists/lists_column_view.hpp Show resolved Hide resolved
cpp/include/cudf/structs/structs_column_view.hpp Outdated Show resolved Hide resolved
Co-authored-by: Vyas Ramasubramani <[email protected]>
@karthikeyann karthikeyann requested a review from vyasr May 28, 2022 00:31
@karthikeyann
Copy link
Contributor Author

@gpucibot merge

@rapids-bot rapids-bot bot merged commit 3ab2c40 into rapidsai:branch-22.08 Jun 1, 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