Add runnable examples to replace demo directory #56
Conversation
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
Replace demo/ directory with idiomatic Go examples in example_test.go: - Example() - basic usage - Example_serialization() - binary marshaling with error handling - Example_merge() - merging sketches for distributed counting - Example_precision() - precision level trade-offs - Example_insertHash() - using pre-computed hashes All examples use modern Go idioms (range over int, fmt.Appendf) and proper error handling (log.Fatal vs panic). Examples will appear on pkg.go.dev automatically. Updated Contributing.md to show how to run examples with go test. Closes #55
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
Replaces the demo/ directory (mentioned in Contributing.md but removed in #42) with idiomatic Go examples that will appear on pkg.go.dev.
Changes
Added
example_test.gowith 5 examples:Example()- Basic usageExample_serialization()- Binary marshaling with error handlingExample_merge()- Merging sketches for distributed countingExample_precision()- Comparing precision levels (p=14 vs p=16)Example_insertHash()- Using pre-computed hash valuesUpdated
Contributing.mdto referencego test -run Example -vinstead of the removed demo.All examples use modern Go idioms (range over int, fmt.Appendf) and proper error handling (log.Fatal). Examples verified with go test and modernize tool.
Closes #55