docs(hashing): fix misquoted note in StringFnV1AFullHasher (#254) - #276
Merged
Conversation
The XML doc for StringFnV1AFullHasher quoted StringFnV1AHasher's remarks as "for keys with significant non-ASCII content, a full UTF-8 or UTF-16 hash is preferable." That wording is a conflation of two hashers: the phrase "for keys with significant non-ASCII content" actually comes from StringMurmur3Hasher, not StringFnV1AHasher. Replace it with the verbatim note from StringFnV1AHasher: "For Unicode-heavy workloads, a full UTF-8 or UTF-16 hash is preferable." Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR corrects a misattributed “direct quote” in the public XML documentation for StringFnV1AFullHasher, aligning the quoted sentence with the exact wording used in StringFnV1AHasher’s remarks.
Changes:
- Replaces the misquoted sentence in
StringFnV1AFullHasher’s<remarks>with the verbatim note fromStringFnV1AHasher. - Keeps the documentation’s intent (guidance on Unicode-heavy workloads) while fixing the quotation accuracy.
Coverage
Files below 100% line coverage
|
Benchmarks4 regressions Highlights
Collections (376)
Hashers (100)
Same-runner A/B (sharded 6-way): main ( |
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.
Summary
Fixes #254. The XML doc comment for
StringFnV1AFullHasherpresented a direct quotation (in quotation marks, attributed toStringFnV1AHasher's remarks) that did not match the source verbatim — the quoted wording was a conflation of two different hashers."for keys with significant non-ASCII content, a full UTF-8 or UTF-16 hash is preferable."StringFnV1AHasher's actual note reads:"For Unicode-heavy workloads, a full UTF-8 or UTF-16 hash is preferable."StringMurmur3Hasher, notStringFnV1AHasher.This replaces the misquoted text with the verbatim note from
StringFnV1AHasher, so the quotation marks now promise a quote that matches its source.Scope
One file, doc-only. No behavioral change.
🤖 Generated with Claude Code