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 strings / header files #10937

Merged
merged 6 commits into from
Jun 2, 2022
Merged

Fix Doxygen warnings in strings / header files #10937

merged 6 commits into from
Jun 2, 2022

Conversation

karthikeyann
Copy link
Contributor

@karthikeyann karthikeyann commented May 23, 2022 •
edited
Loading

Fixes parts of #9373
added missing documentation to fix doxygen warnings in multiple files
ignored docs for cudf::string_view::const_iterator

fixes 78 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 23, 2022
@karthikeyann karthikeyann self-assigned this May 23, 2022
@karthikeyann karthikeyann requested a review from a team as a code owner May 23, 2022 21:15
@codecov
Copy link

codecov bot commented May 24, 2022 •
edited
Loading

Codecov Report

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

@@               Coverage Diff               @@
##             branch-22.08   #10937   +/-   ##
===============================================
  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 138c64b...b3603f2. Read the comment docs.

codereport
codereport approved these changes May 24, 2022
View reviewed changes
Copy link
Contributor

@codereport codereport left a comment

Choose a reason for hiding this comment

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

lgtm 👍

cpp/include/cudf/strings/char_types/char_types.hpp Show resolved Hide resolved
@codereport codereport changed the title fix doxygen warnings in strings/ header files Fix Doxygen warnings in strings / header files May 24, 2022
davidwendt
davidwendt requested changes May 24, 2022
View reviewed changes
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 like the global change to remove periods from @param made some mistakes. I'm not sure this is worth doing in the PR since this does not effect the warnings. My previous comments were just trying to follow conventions for newer comments and not necessarily requiring a global change to existing documentation.

cpp/include/cudf/strings/detail/convert/fixed_point.cuh Outdated Show resolved Hide resolved
cpp/include/cudf/strings/find.hpp Outdated Show resolved Hide resolved
cpp/include/cudf/strings/find.hpp Outdated Show resolved Hide resolved
cpp/include/cudf/strings/substring.hpp Outdated Show resolved Hide resolved
cpp/include/cudf/strings/string_view.hpp Outdated Show resolved Hide resolved
cpp/include/cudf/strings/detail/utilities.cuh Show resolved Hide resolved
cpp/include/cudf/strings/detail/utilities.cuh Show resolved Hide resolved
cpp/include/cudf/strings/detail/copying.hpp Outdated Show resolved Hide resolved
cpp/include/cudf/strings/convert/convert_durations.hpp Outdated Show resolved Hide resolved
cpp/include/cudf/strings/convert/convert_datetime.hpp Outdated Show resolved Hide resolved
@vyasr vyasr mentioned this pull request May 24, 2022
Merged
davidwendt
davidwendt requested changes May 25, 2022
View reviewed changes
cpp/include/cudf/strings/char_types/char_types.hpp Outdated Show resolved Hide resolved
cpp/include/cudf/strings/combine.hpp Outdated Show resolved Hide resolved
cpp/include/cudf/strings/combine.hpp Outdated Show resolved Hide resolved
cpp/include/cudf/strings/combine.hpp Outdated Show resolved Hide resolved
davidwendt
davidwendt requested changes May 31, 2022
View reviewed changes
cpp/include/cudf/strings/detail/convert/fixed_point.cuh Outdated Show resolved Hide resolved
cpp/include/cudf/strings/detail/utilities.cuh Outdated Show resolved Hide resolved
cpp/include/cudf/strings/detail/utilities.cuh Outdated Show resolved Hide resolved
cpp/include/cudf/strings/replace.hpp Outdated Show resolved Hide resolved
cpp/include/cudf/strings/substring.hpp Outdated Show resolved Hide resolved
@karthikeyann
Copy link
Contributor Author

@gpucibot merge

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

@codereport codereport codereport approved these changes

@davidwendt davidwendt davidwendt approved these changes

@vuule vuule Awaiting requested review from vuule vuule 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.
3 participants
@karthikeyann @codereport @davidwendt