Refresh README and docs for the v1.1.0 surface - #58
Merged
Conversation
Documents the collections and hashers added between v1.0.1 and the [Unreleased] block in CHANGELOG.md so the README that ships inside the NuGet package matches the API users actually get. - README.md gains a Collections list (LongDictionary, sets) and a Custom-hashing pointer that names the new built-in hashers. - docs/api/collections.md gains LongDictionary, CeleritySet, and IntSet sections, the IEnumerable<KeyValuePair> constructor, the Remove(key, out value) capture overload, and the IReadOnlyDictionary<TKey, TValue?> interface implementation. - docs/api/hashing.md gains Int32Murmur3Hasher, Int64WangHasher, UInt32Hasher, UInt64Hasher, GuidHasher, and DefaultHasher<T>, plus a "choosing a hasher" table. - docs/README.md index updated to mention all the now-documented types. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2 tasks
3 tasks
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
1 participant
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
LongDictionary,CeleritySet,IntSet, theIEnumerable<KeyValuePair>constructor, theRemove(key, out value)capture overload, and theIReadOnlyDictionary<TKey, TValue?>interface implementation indocs/api/collections.mdInt32Murmur3Hasher,Int64WangHasher,UInt32Hasher,UInt64Hasher,GuidHasher,DefaultHasher<T>) indocs/api/hashing.md, plus a "choosing a hasher" tabledocs/README.mdindexThis is the first of three PRs prepping for the v1.1.0 release. Must merge before the v1.1.0 tag because
PackageReadmeFileshipsREADME.mdinside the .nupkg.Test plan
dotnet build src/clean (0 errors)