Skip to content

fix: documentation#16

Merged
hayabusa-cloud merged 3 commits into
mainfrom
fix/semantics
May 5, 2026
Merged

fix: documentation#16
hayabusa-cloud merged 3 commits into
mainfrom
fix/semantics

Conversation

@hayabusa-cloud
Copy link
Copy Markdown
Owner

Summary

This pull request updates documentation, dependency pins, and bounded-pool coverage behavior.

Changes

  • Update README API tables to match the current IoVecFromBytesSlice(iov [][]byte) []IoVec signature.
  • Clarify that default pool Get behavior blocks and that SetNonblock(true) converts empty or full frontiers into iox.ErrWouldBlock.
  • Dump iox and spin module versions.

Signed-off-by: Robin He <git@hybscloud.com>
Signed-off-by: Robin He <git@hybscloud.com>
Signed-off-by: Robin He <git@hybscloud.com>
Copilot AI review requested due to automatic review settings May 5, 2026 07:29
@codecov
Copy link
Copy Markdown

codecov Bot commented May 5, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 and SetNonblock(true) switches empty/full behavior to iox.ErrWouldBlock.
  • Bump code.hybscloud.com/iox and code.hybscloud.com/spin versions 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.

Comment thread doc.go
@hayabusa-cloud hayabusa-cloud merged commit aee4329 into main May 5, 2026
15 checks passed
@hayabusa-cloud hayabusa-cloud deleted the fix/semantics branch May 5, 2026 07:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants