Repository navigation
docs: describe the published in-process leg in the bench script and reattach a split doc comment - #216
Merged
Conversation
…eattach a split doc comment The in-process cap comment in scripts/bench.sh still called the 32 GiB shape a forecast for the next pass, but the committed leg carries it: 524 288 messages at 64 KiB with every drain row publishing, and no failures left. Restate it in present tense, matching benches/README.md. RedisClient::trim_interval was inserted between instance_id and its doc comment, so rustdoc attached the identity description to the wrong item.
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
shove-docs | 5dbe427 | Commit Preview URL Branch Preview URL |
Sep 25 2026, 11:15 PM |
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
scripts/bench.sh: the in-process byte-cap comment still said the 32 GiB shape was not in the published document and projected its timings. The committed leg carries it (524 288 messages at 64 KiB, all twelve drain rows publishing in 3.4-9.1 s, no failures). The comment now states the measured outcome, matchingbenches/README.md.src/backends/redis/client.rs:trim_interval()had been inserted betweeninstance_id()and its doc comment, so the identity description documented the wrong function. The two are reordered; no code change.Test plan
bash -n scripts/bench.shcargo clippy --lib --no-default-features --features redis-streams -- -D warningscargo fmt -- --check