refactor: documents clarification #10
Merged
Merged
Conversation
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 pull request clarifies the semantics of spin.Pause across architectures (especially wasm/fallback behavior), updates related README/test wording, and adjusts CI to add test timeouts while upgrading GitHub Actions dependencies.
Changes:
- Clarify
Pause(cycles ...int)as a “pause-hint repeat count” (default 30) rather than a calibrated CPU-cycle delay, and document wasm/fallback yielding behavior. - Update
pause_test.goand translated READMEs to match the clarifiedPausesemantics/terminology. - Update CI workflow action versions and add
go test -timeout 120sto reduce hangs.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| README.md | Expands Pause API description to cover default count and wasm/fallback behavior. |
| README.zh-CN.md | Same Pause clarification in Simplified Chinese. |
| README.ja.md | Same Pause clarification in Japanese. |
| README.fr.md | Same Pause clarification in French. |
| README.es.md | Same Pause clarification in Spanish. |
| pause.go | Updates exported Pause doc comment to describe behavior per target. |
| pause_test.go | Updates test comments to use “pause hints” terminology. |
| .github/workflows/ci.yml | Adds Go test timeouts and bumps action versions used in CI. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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 and code comments to clarify the behavior of the
Pausefunction, especially regarding its use of CPU pause hints and its behavior across different platforms.It also upgrades GitHub Actions workflow dependencies and adds timeouts to Go test invocations for improved CI reliability.