Skip to content

fix doxygen warnings in cudf/io/ avro, csv, json, orc, parquet header files - #10912

Merged
rapids-bot[bot] merged 11 commits into
NVIDIA:branch-22.08from
karthikeyann:doc-fix_warnings8
May 28, 2022
Merged

fix doxygen warnings in cudf/io/ avro, csv, json, orc, parquet header files#10912
rapids-bot[bot] merged 11 commits into
NVIDIA:branch-22.08from
karthikeyann:doc-fix_warnings8

Conversation

@karthikeyann

@karthikeyann karthikeyann commented May 20, 2022

Copy link
Copy Markdown
Contributor

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

  • cpp/include/cudf/io/avro.hpp
  • cpp/include/cudf/io/csv.hpp
  • cpp/include/cudf/io/json.hpp
  • cpp/include/cudf/io/orc.hpp
  • cpp/include/cudf/io/orc_metadata.hpp
  • cpp/include/cudf/io/parquet.hpp

fixes 194 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 self-assigned this May 20, 2022
@karthikeyann
karthikeyann requested a review from a team as a code owner May 20, 2022 08:50
PointKernel
PointKernel reviewed May 20, 2022
View reviewed changes

@PointKernel PointKernel left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The burn down started before the creation of this PR. Should we target the work for the next release?

Comment thread cpp/include/cudf/io/avro.hpp
Comment thread cpp/include/cudf/io/parquet.hpp Outdated
@karthikeyann
karthikeyann requested a review from PointKernel May 21, 2022 14:45
@karthikeyann

karthikeyann commented May 21, 2022

Copy link
Copy Markdown
Contributor Author

The burn down started before the creation of this PR. Should we target the work for the next release?

This PR only has changes only in comments. Since entire documentation cleanup will take more PRs, we can move target to next release.

@github-actions github-actions Bot added CMake CMake build issue conda Java Affects Java cuDF API. labels May 21, 2022
@karthikeyann
karthikeyann changed the base branch from branch-22.06 to branch-22.08 May 21, 2022 16:03
@karthikeyann
karthikeyann requested review from a team as code owners May 21, 2022 16:03
@jlowe
jlowe removed the request for review from a team May 23, 2022 13:21
@jlowe

jlowe commented May 23, 2022

Copy link
Copy Markdown
Contributor

I removed the Java review request, as there aren't any Java files modified. I assume this was accidentally triggered by the rebase to 22.08.

@jlowe
jlowe removed request for a team May 23, 2022 13:24
@jlowe

jlowe commented May 23, 2022

Copy link
Copy Markdown
Contributor

Removed ops and cmake review for similar reasons.

@karthikeyann

karthikeyann commented May 23, 2022

Copy link
Copy Markdown
Contributor Author

rerun tests

@codecov

codecov Bot commented May 23, 2022 •
edited
Loading

Copy link
Copy Markdown

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   #10912   +/-   ##
===============================================
  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...2848d22. Read the comment docs.

@karthikeyann
karthikeyann requested a review from a team May 24, 2022 20:15
@github-actions github-actions Bot removed CMake CMake build issue Java Affects Java cuDF API. conda labels May 24, 2022
@github-actions github-actions Bot added the conda label May 25, 2022
vyasr
vyasr approved these changes May 25, 2022
View reviewed changes

@vyasr vyasr left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

A lot of these docstrings would be nice if they could be copydoced from a single source of truth, but I'll leave it up to you if you think that's a good idea or not since I requested something similar on a couple of your other PRs.

Comment thread conda/recipes/libcudf/meta.yaml Outdated
- test -f $PREFIX/include/cudf/lists/gather.hpp
- test -f $PREFIX/include/cudf/lists/list_view.hpp
- test -f $PREFIX/include/cudf/lists/lists_column_view.hpp
- test -f $PREFIX/include/cudf/lists/list_view.hpp

@vyasr vyasr May 25, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Why is this removed?

@ttnghia ttnghia May 26, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This is duplicate of line 184 above.

@karthikeyann

karthikeyann commented May 28, 2022

Copy link
Copy Markdown
Contributor Author

@gpucibot merge

1 similar comment
@karthikeyann

karthikeyann commented May 28, 2022

Copy link
Copy Markdown
Contributor Author

@gpucibot merge

@github-actions github-actions Bot removed the conda label May 28, 2022
@karthikeyann karthikeyann added 5 - Ready to Merge Testing and reviews complete, ready to merge and removed 3 - Ready for Review Ready for review by team 4 - Needs Review Waiting for reviewer to review or respond labels May 28, 2022
@rapids-bot
rapids-bot Bot merged commit e03d4e6 into NVIDIA:branch-22.08 May 28, 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
@ttnghia ttnghia ttnghia approved these changes
@PointKernel PointKernel PointKernel approved these changes
@trxcllnt trxcllnt Awaiting requested review from trxcllnt trxcllnt was automatically assigned from rapidsai/cudf-cpp-codeowners

Assignees

@karthikeyann karthikeyann

Labels

5 - Ready to Merge Testing and reviews complete, ready to merge 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.

5 participants

@karthikeyann @jlowe @vyasr @ttnghia @PointKernel