refactor: export FrequentItemValue and improve docs#98
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refactors the frequencies module to publicly re-export FrequentItemValue and expands/reshapes documentation across the frequencies and hll modules.
Changes:
- Expanded and reorganized
frequenciesmodule-level documentation and added a public re-export ofFrequentItemValue. - Tweaked rustdoc formatting in
hlldocs (argument formatting and range formatting). - Removed an unused
#[allow(unused_imports)]attribute in thehashmodule.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
datasketches/src/hll/union.rs |
Minor rustdoc argument formatting updates for HllUnion docs. |
datasketches/src/hll/sketch.rs |
Minor rustdoc argument formatting updates for HllSketch docs. |
datasketches/src/hash/mod.rs |
Removes a now-unnecessary #[allow(unused_imports)] attribute. |
datasketches/src/frequencies/mod.rs |
Major module-level documentation rewrite and re-export of FrequentItemValue. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
tisonkun
force-pushed
the
export-frequency-item-sketch
branch
2 times, most recently
from
182c6c2 to
0dc9b9f
Compare
Signed-off-by: tison <wander4096@gmail.com>
tisonkun
force-pushed
the
export-frequency-item-sketch
branch
from
0dc9b9f to
9a0d7fc
Compare
tisonkun
force-pushed
the
export-frequency-item-sketch
branch
from
bfe2aa3 to
6aa282c
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 24 out of 24 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: tison <wander4096@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.