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

Add missing documentation in aggregation.hpp #10887

Merged
merged 5 commits into from
May 28, 2022

Conversation

karthikeyann
Copy link
Contributor

Fixes parts of #9373
added missing documentation in aggregation.hpp to fix doxygen warnings
fixes 108 warnings.

@karthikeyann karthikeyann added 3 - Ready for Review Ready for review by team doc Documentation 4 - Needs Review Waiting for reviewer to review or respond non-breaking Non-breaking change labels May 18, 2022
@karthikeyann karthikeyann self-assigned this May 18, 2022
@karthikeyann karthikeyann requested a review from a team as a code owner May 18, 2022 19:11
@github-actions github-actions bot added the libcudf Affects libcudf (C++/CUDA) code. label May 18, 2022
@codecov
Copy link

codecov bot commented May 18, 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   #10887   +/-   ##
===============================================
  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...6529956. Read the comment docs.

Comment on lines +188 to +189
/// constructor inherited from cudf::aggregation
using aggregation::aggregation;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

using declaration style here instead of old code.
This is the only code change in this PR.

@davidwendt
Copy link
Contributor

I don't know if the returned std::unique_ptr<whatever> needs to say @return A pointer to a whatever. I'd vote for it just saying @return A whatever object instead.
FWIW, there are some inconsistencies here:
https://github.com/rapidsai/cudf/pull/10887/files#diff-2fb738b709da644f7015e9d81f1aaf571f80b9ff8e33c9fa7634aa8400e9ea2cR670
@return A pointer to a new TDIGEST aggregation
and here:
https://github.com/rapidsai/cudf/pull/10887/files#diff-2fb738b709da644f7015e9d81f1aaf571f80b9ff8e33c9fa7634aa8400e9ea2cR708
@return A MERGE_TDIGEST aggregation object.

@karthikeyann
Copy link
Contributor Author

karthikeyann commented May 21, 2022

I'd vote for it just saying @return A whatever object instead.

I would prefer to remove pointer as well. but object is also not accurate since we don't return object, but unique_ptr. but if the convention is to use object at places where unique_ptr is used, this update is fine. updated few other locations with same update.

@karthikeyann karthikeyann requested a review from davidwendt May 21, 2022 15:57
@karthikeyann
Copy link
Contributor Author

rerun tests

@karthikeyann karthikeyann added 5 - Merge After Dependencies and removed 3 - Ready for Review Ready for review by team 4 - Needs Review Waiting for reviewer to review or respond labels May 23, 2022
@karthikeyann
Copy link
Contributor Author

rerun tests

@karthikeyann
Copy link
Contributor Author

rerun tests

@karthikeyann karthikeyann changed the base branch from branch-22.06 to branch-22.08 May 27, 2022 10:34
@karthikeyann
Copy link
Contributor Author

rerun tests

@karthikeyann karthikeyann added 5 - Ready to Merge Testing and reviews complete, ready to merge and removed 5 - Merge After Dependencies labels May 28, 2022
@karthikeyann
Copy link
Contributor Author

@gpucibot merge

@rapids-bot rapids-bot bot merged commit c897f48 into rapidsai:branch-22.08 May 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Development

Successfully merging this pull request may close these issues.

3 participants