docs: refresh README public package guidance#17
Merged
Conversation
Signed-off-by: Robin He <git@hybscloud.com>
There was a problem hiding this comment.
Pull request overview
Documentation-only refresh of the README family: adds a Benchmarks workflow badge and rewrites the multishot subscriber callback paragraph to reference the current API (OnStep/OnStop, MultishotStep, step.Cancelled, MultishotHandler).
Changes:
- Add Benchmarks badge linking to the
public-benchmarks.ymlworkflow. - Rewrite multishot callback contract paragraph using current API names.
- Apply the same updates consistently across English, Chinese, Japanese, French, and Spanish READMEs.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Adds Benchmarks badge and updated multishot callback paragraph. |
| README.zh-CN.md | Mirrors English changes in Simplified Chinese. |
| README.ja.md | Mirrors English changes in Japanese. |
| README.fr.md | Mirrors English changes in French. |
| README.es.md | Mirrors English changes in Spanish. |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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 PR refreshes the README language set so the public package page exposes the benchmark workflow status and describes multishot callbacks using the current API terms.
Changes
Benchmarksbadge that links to the standalone public benchmark workflow.OnStepobservesMultishotStep,OnStopruns at most once when callbacks remain enabled until terminal observation, andstep.Cancelledrepresents the-ECANCELEDkernel verdict.