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 the example in documentation for get_dremel_data() #17242

Conversation

mhaseeb123
Copy link
Member

Description

Closes #11396. Fixes the example in the documentation of get_dremel_data()

Checklist

  • I am familiar with the Contributing Guidelines.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

@github-actions github-actions bot added the libcudf Affects libcudf (C++/CUDA) code. label Nov 4, 2024
@mhaseeb123 mhaseeb123 added 2 - In Progress Currently a work in progress doc Documentation non-breaking Non-breaking change labels Nov 4, 2024
@mhaseeb123 mhaseeb123 marked this pull request as ready for review November 5, 2024 02:11
@mhaseeb123 mhaseeb123 requested a review from a team as a code owner November 5, 2024 02:11
@mhaseeb123 mhaseeb123 marked this pull request as draft November 5, 2024 02:33
@mhaseeb123 mhaseeb123 marked this pull request as ready for review November 5, 2024 04:10
@mhaseeb123 mhaseeb123 requested a review from vuule November 5, 2024 20:48
* col = {[], [[], [1, 2, 3], [4, 5]], [[]]}
* dremel_offsets = { 0, 1, 7, 8}
* def_levels = { 0 1, 2, 2, 2, 2, 2, 1 }
* rep_levels = { 0, 0, 1, 2, 2, 1, 2, 0 }
* ```
*
* Since repetition and definition levels arrays contain a value for each empty list, the size of
Copy link
Member Author

@mhaseeb123 mhaseeb123 Nov 5, 2024

Choose a reason for hiding this comment

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

Reviewers: Would love an extra set of eyes at the explanation of the algorithm at L120-151 if you could. I looked into it while making the edits and the explanation looked fine to me so I didn't make any changes. Thanks!

Copy link
Contributor

Choose a reason for hiding this comment

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

Looks good, I'm just confused as to why we included the algorithm description in the public header :)
Not a concern for this PR

@mhaseeb123 mhaseeb123 added 3 - Ready for Review Ready for review by team and removed 2 - In Progress Currently a work in progress labels Nov 5, 2024
cpp/include/cudf/lists/detail/dremel.hpp Outdated Show resolved Hide resolved
cpp/include/cudf/lists/detail/dremel.hpp Show resolved Hide resolved
cpp/include/cudf/lists/detail/dremel.hpp Outdated Show resolved Hide resolved
Co-authored-by: Vukasin Milovanovic <[email protected]>
@mhaseeb123 mhaseeb123 requested a review from vuule November 6, 2024 02:41
@mhaseeb123 mhaseeb123 added 4 - Needs Review Waiting for reviewer to review or respond and removed 3 - Ready for Review Ready for review by team labels Nov 6, 2024
Copy link
Contributor

@hyperbolic2346 hyperbolic2346 left a comment

Choose a reason for hiding this comment

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

Some small nits.

cpp/include/cudf/lists/detail/dremel.hpp Outdated Show resolved Hide resolved
cpp/include/cudf/lists/detail/dremel.hpp Outdated Show resolved Hide resolved
@mhaseeb123 mhaseeb123 added 5 - Ready to Merge Testing and reviews complete, ready to merge and removed 4 - Needs Review Waiting for reviewer to review or respond labels Nov 6, 2024
@vyasr
Copy link
Contributor

vyasr commented Nov 7, 2024

/merge

@rapids-bot rapids-bot bot merged commit bbd3b43 into rapidsai:branch-24.12 Nov 7, 2024
102 checks passed
@mhaseeb123 mhaseeb123 deleted the doc/dremel-example-docstring-update branch November 7, 2024 17:39
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
Status: Landed
Development

Successfully merging this pull request may close these issues.

The example in the documentation for get_dremel_data() seems incorrect at line#1764
7 participants