chore(sdk): IggyProducer docs for Rust SDK - #3989
Merged
Merged
Conversation
|
Thanks for the PR. It is labeled Slash commands (own line, regular comment) move it around the queue:
See CONTRIBUTING.md for details. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #3989 +/- ##
============================================
- Coverage 85.15% 85.08% -0.07%
Complexity 1402 1402
============================================
Files 1230 1230
Lines 181317 181408 +91
Branches 147611 147704 +93
============================================
- Hits 154392 154354 -38
- Misses 22874 22973 +99
- Partials 4051 4081 +30
🚀 New features to boost your workflow:
|
2 tasks
Contributor
Author
|
/ready |
haubur
force-pushed
the
chore/producer-docs
branch
from
September 1, 2026 08:39
ec29607 to
24a09a0
Compare
spetz
previously approved these changes
Sep 1, 2026
mmodzelewski
previously approved these changes
Sep 1, 2026
The new IggyProducer docs promised more than the code delivers: the readiness gate starts open and is skipped without retries, only adjacent buffered sends merge, a panic in call() itself ends the error task, retries are not evenly spaced, and a zero linger spins the worker. Fix those claims, name the overflow error instead of "the former", and state the duplicate-commit caveat once under "Retrying" with links from elsewhere. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_019pqDbbzdWsPgamaKXK69y1
A shard re-armed its linger deadline from the last flush check and polled it even with an empty buffer, so an idle shard woke up every linger period and a zero linger spun a core. The deadline is now armed by the first send buffered after a flush and polled only while the buffer is non-empty, which also gives linger its usual meaning: a window that starts with the first buffered send. The error task caught panics only in the future an ErrorCallback returned. A panic in call() itself ended the task, and every later failure was dropped without a trace. Both are now caught, matching what the rustdoc promises. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_019pqDbbzdWsPgamaKXK69y1
hubcio
approved these changes
Sep 1, 2026
mmodzelewski
approved these changes
Sep 1, 2026
piotr-laserdata
approved these changes
Sep 1, 2026
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.
Which issue does this PR address?
Closes #3988
Rationale
Improving Rust SDK docs.
What changed?
Added rustdocs for the IggyProducer, Dispatcher, BackgroundConfig and Sharding.
Local Execution
AI Usage
Drafts sometimes written by AI, then usually rewritten or adapted.
AI claims checked against code in best effort.