fix: documentation#16
Merged
Merged
Conversation
Signed-off-by: Robin He <git@hybscloud.com>
Signed-off-by: Robin He <git@hybscloud.com>
Signed-off-by: Robin He <git@hybscloud.com>
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 aligns public-facing documentation with the current IoVecFromBytesSlice API, clarifies BoundedPool blocking vs nonblocking semantics, and updates pinned dependency versions while adjusting contention tests to behave better under the race detector.
Changes:
- Update all README API tables to reflect
IoVecFromBytesSlice(iov [][]byte) []IoVec. - Clarify in package docs that
Get()blocks by default andSetNonblock(true)switches empty/full behavior toiox.ErrWouldBlock. - Bump
code.hybscloud.com/ioxandcode.hybscloud.com/spinversions and tweak BoundedPool contention/stress tests (skip or reduce workload under-race).
Reviewed changes
Copilot reviewed 8 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| README.md | Fix IoVec API signature in the English README table. |
| README.zh-CN.md | Fix IoVec API signature in the Chinese README table. |
| README.ja.md | Fix IoVec API signature in the Japanese README table. |
| README.fr.md | Fix IoVec API signature in the French README table. |
| README.es.md | Fix IoVec API signature in the Spanish README table. |
| doc.go | Update package docs to describe default blocking behavior and SetNonblock(true) semantics. |
| bounded_pool_test.go | Reduce/skip high-contention stress under race instrumentation; small refactor for workload selection. |
| go.mod | Pin newer iox/spin versions. |
| go.sum | Update checksums to match the new module pins. |
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
This pull request updates documentation, dependency pins, and bounded-pool coverage behavior.
Changes
IoVecFromBytesSlice(iov [][]byte) []IoVecsignature.Getbehavior blocks and thatSetNonblock(true)converts empty or full frontiers intoiox.ErrWouldBlock.ioxandspinmodule versions.