Skip to content

refactor!: rename get_result to to_sketch#81

Merged
tisonkun merged 3 commits into
mainfrom
chore
Feb 1, 2026
Merged

refactor!: rename get_result to to_sketch#81
tisonkun merged 3 commits into
mainfrom
chore

Conversation

@tisonkun

@tisonkun tisonkun commented Feb 1, 2026

Copy link
Copy Markdown
Member

Signed-off-by: tison <wander4096@gmail.com>
Comment thread CHANGELOG.md Outdated

Copilot AI 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.

Pull request overview

This PR performs a breaking refactor to improve API consistency by renaming the get_result method to to_sketch for union types. The change affects both HllUnion and CpcUnion, aligning their method names with a clearer, more descriptive convention.

Changes:

  • Renamed HllUnion::get_result() to HllUnion::to_sketch()
  • Renamed CpcUnion::get_result() to CpcUnion::to_sketch() (introduced with new CPC sketch support)
  • Updated all test files and documentation to use the new method name

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
datasketches/src/hll/union.rs Renamed method from get_result to to_sketch and improved documentation with a period at the end of the summary line
datasketches/src/cpc/union.rs Renamed method from get_result to to_sketch and added comprehensive documentation with examples
datasketches/src/hll/mod.rs Updated module-level documentation example to use to_sketch
datasketches/tests/hll_union_test.rs Updated all test cases to use to_sketch instead of get_result
datasketches/tests/cpc_union_test.rs Updated all test cases to use to_sketch instead of get_result
CHANGELOG.md Documented the breaking change for HllUnion and the new CpcUnion feature

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread CHANGELOG.md Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

@PsiACE PsiACE 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.

lgtm

@tisonkun tisonkun merged commit ae13a83 into main Feb 1, 2026
9 checks passed
@tisonkun tisonkun deleted the chore branch February 1, 2026 05:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants