docs: update references for generic buffer API#10
Merged
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates all documentation and benchmark names to reflect the generic buffer API introduced in PR #9, which replaced 36 type-specific functions with 3 generic functions using Go's BufferType constraint. The changes ensure that examples, API listings, and benchmark names accurately represent the new IoVecFrom[T BufferType] generic function.
Changes:
- Updated code examples across all documentation files to use
IoVecFrominstead ofIoVecFromSmallBuffers - Added generic function signature
IoVecFrom[T BufferType](buffers []T) []IoVecto API listings in all README files - Renamed benchmark functions to follow new naming convention (e.g.,
BenchmarkIoVecFrom_SmallBuffer_8)
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| doc.go | Updated package documentation example to use generic IoVecFrom function |
| benchmark_test.go | Renamed benchmark functions from BenchmarkIoVecFromSmallBuffers_* to BenchmarkIoVecFrom_SmallBuffer_* pattern |
| README.md | Updated English documentation with generic API signature and example usage |
| README.zh-CN.md | Updated Chinese documentation with generic API signature and example usage |
| README.ja.md | Updated Japanese documentation with generic API signature and example usage |
| README.fr.md | Updated French documentation with generic API signature and example usage |
| README.es.md | Updated Spanish documentation with generic API signature and example usage |
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
Update documentation and benchmark names to reflect the generic functions introduced in #9.
Changes
IoVecFromSmallBufferswithIoVecFromin README examplesIoVecFrom[T BufferType]generic signaturedoc.goexample to useIoVecFromBenchmarkIoVecFrom_SmallBuffer_8, etc.)Test plan
go vet ./...cleango test -race ./...passes