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.

Sign up for GitHub

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

Jump to bottom

fix doxygen warnings in cudf/io/types.hpp, other header files #10913

Merged
merged 7 commits into from
May 27, 2022
Merged

fix doxygen warnings in cudf/io/types.hpp, other header files #10913

merged 7 commits into from
May 27, 2022

Conversation

karthikeyann
Copy link
Contributor

@karthikeyann karthikeyann commented May 20, 2022 •
edited
Loading

Fixes parts of #9373
added missing documentation to fix doxygen warnings in multiple files

fixes 93 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 20, 2022
@karthikeyann karthikeyann requested a review from vuule May 20, 2022 08:59
@karthikeyann karthikeyann self-assigned this May 20, 2022
@karthikeyann karthikeyann requested a review from a team as a code owner May 20, 2022 08:59
vuule
vuule requested changes May 20, 2022
View reviewed changes
Copy link
Contributor

@vuule vuule 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 for the most part. A few corrections/questions:

cpp/include/cudf/io/datasource.hpp Outdated Show resolved Hide resolved
cpp/include/cudf/io/datasource.hpp Outdated Show resolved Hide resolved
cpp/include/cudf/io/datasource.hpp Outdated Show resolved Hide resolved
cpp/include/cudf/io/datasource.hpp Outdated Show resolved Hide resolved
cpp/include/cudf/io/types.hpp Show resolved Hide resolved
cpp/include/cudf/io/datasource.hpp Outdated Show resolved Hide resolved
@karthikeyann karthikeyann requested a review from vuule May 21, 2022 14:14
@karthikeyann karthikeyann requested review from a team as code owners May 21, 2022 16:03
@karthikeyann karthikeyann changed the base branch from branch-22.06 to branch-22.08 May 21, 2022 16:03
@ajschmidt8
Copy link
Member

Removing ops-codeowners from the required reviews since it doesn't seem there are any file changes that we're responsible for. Feel free to add us back if necessary.

@ajschmidt8 ajschmidt8 removed the request for review from a team May 23, 2022 13:45
@karthikeyann karthikeyann requested review from a team and removed request for a team May 23, 2022 21:01
@karthikeyann karthikeyann requested a review from vuule May 24, 2022 20:15
@codecov
Copy link

codecov bot commented May 24, 2022 •
edited
Loading

Codecov Report

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

@@               Coverage Diff               @@
##             branch-22.08   #10913   +/-   ##
===============================================
  Coverage                ?   86.33%           
===============================================
  Files                   ?      144           
  Lines                   ?    22689           
  Branches                ?        0           
===============================================
  Hits                    ?    19588           
  Misses                  ?     3101           
  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 9e4fc74...b235bc9. Read the comment docs.

@karthikeyann karthikeyann requested a review from a team May 25, 2022 07:02
vyasr
vyasr approved these changes May 25, 2022
View reviewed changes
Copy link
Contributor

@vyasr vyasr left a comment

Choose a reason for hiding this comment

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

One minor typo fix. Also, I asked this on another of your PRs: I'm not sure why pure is needed based on the contents of the doxygen docs for the pure command. I'm approving assuming you can address that question consistently across all the doxygen PRs. Thanks!

cpp/include/cudf/io/types.hpp Outdated Show resolved Hide resolved
@karthikeyann
Copy link
Contributor Author

@gpucibot merge

@rapids-bot rapids-bot bot merged commit fd944b4 into rapidsai:branch-22.08 May 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vyasr vyasr vyasr approved these changes

@vuule vuule vuule approved these changes

@jrhemstad jrhemstad Awaiting requested review from jrhemstad jrhemstad is a code owner automatically assigned from rapidsai/cudf-cpp-codeowners

Assignees

@karthikeyann karthikeyann

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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@karthikeyann @ajschmidt8 @vyasr @vuule