Skip to content

chore(sdk): IggyConsumer docs - #3913

Open
haubur wants to merge 4 commits into
apache:masterfrom
haubur:chore/sdk-docs-consumer-producer
Open

chore(sdk): IggyConsumer docs#3913
haubur wants to merge 4 commits into
apache:masterfrom
haubur:chore/sdk-docs-consumer-producer

Conversation

@haubur

@haubur haubur commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Closes #3912
Relates #3306

Local Execution

  • Pre-commit hooks ran

AI Usage

None

@github-actions

Copy link
Copy Markdown

Thanks for the PR. It is labeled S-waiting-on-review and queued for review.

Slash commands (own line, regular comment) move it around the queue:

  • /ready - back to S-waiting-on-review after addressing feedback
  • /author - flip to S-waiting-on-author while you finish changes
  • /request-review @user-or-team - request a reviewer

See CONTRIBUTING.md for details.

@github-actions github-actions Bot added the S-waiting-on-review PR is waiting on a reviewer label Aug 18, 2026

@hubcio hubcio left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

most behavioral claims here actually check out against the code, which is rare for a docs PR.

the three crash-safety spots (the auto-commit advice, the guarantees section, the manual-commit example) state the opposite of what the code does, and those are exactly the lines people will build on. the rest is wording cleanup.

really good work @haubur

Comment thread core/sdk/src/clients/consumer.rs Outdated
Comment thread core/sdk/src/clients/consumer.rs Outdated
Comment thread core/sdk/src/clients/consumer.rs
Comment thread core/sdk/src/clients/consumer.rs Outdated
Comment thread core/sdk/src/clients/consumer.rs Outdated
Comment thread core/sdk/src/clients/consumer.rs
Comment thread core/sdk/src/clients/consumer.rs Outdated
Comment thread core/sdk/src/clients/consumer.rs Outdated
Comment thread core/sdk/src/clients/consumer.rs Outdated
Comment thread core/sdk/src/clients/consumer.rs Outdated
@github-actions github-actions Bot added S-waiting-on-author PR is waiting on author response and removed S-waiting-on-review PR is waiting on a reviewer labels Aug 18, 2026
@codecov

codecov Bot commented Aug 18, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 65.17%. Comparing base (e71e3c6) to head (20b549d).
⚠️ Report is 3 commits behind head on master.

Additional details and impacted files
@@              Coverage Diff              @@
##             master    #3913       +/-   ##
=============================================
- Coverage     83.67%   65.17%   -18.51%     
  Complexity     1358     1358               
=============================================
  Files          1212     1212               
  Lines        165138   141315    -23823     
  Branches     132612   108915    -23697     
=============================================
- Hits         138181    92101    -46080     
- Misses        23308    45498    +22190     
- Partials       3649     3716       +67     
Components Coverage Δ
Rust Core 60.23% <ø> (-24.22%) ⬇️
Java SDK 66.67% <ø> (ø)
C# SDK 74.99% <ø> (-1.10%) ⬇️
Python SDK 90.00% <ø> (ø)
PHP SDK 84.48% <ø> (ø)
Node SDK 95.94% <ø> (+0.09%) ⬆️
Go SDK 68.32% <ø> (ø)
Files with missing lines Coverage Δ
core/sdk/src/clients/consumer.rs 71.77% <ø> (ø)

... and 461 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@haubur
haubur force-pushed the chore/sdk-docs-consumer-producer branch from 4c6fc47 to 67d47d3 Compare August 18, 2026 16:42
@haubur

haubur commented Aug 18, 2026

Copy link
Copy Markdown
Contributor Author

/ready

@github-actions github-actions Bot added S-waiting-on-review PR is waiting on a reviewer and removed S-waiting-on-author PR is waiting on author response labels Aug 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-waiting-on-review PR is waiting on a reviewer

Projects

None yet

Development

Successfully merging this pull request may close these issues.

chore(Rust SDK): IggyConsumer docs

2 participants