Skip to content

docs: document sync streaming callbacks in async contexts - #11870

Merged
julian-risch merged 7 commits into
mainfrom
docs/v3-simple-doc-updates
Jul 9, 2026
Merged

docs: document sync streaming callbacks in async contexts#11870
julian-risch merged 7 commits into
mainfrom
docs/v3-simple-doc-updates

Conversation

@julian-risch

@julian-risch julian-risch commented Jul 5, 2026

Copy link
Copy Markdown
Member

Related Issues

Proposed Changes:

  • refactor: accept sync callbacks in run_async #11466 — Streaming docs: new "Sync and Async Callbacks" section in the Choosing the Right Generator guide (with a runnable example) explaining that sync streaming_callbacks are now accepted in async contexts with a logged warning, while async callbacks in sync run still raise.

How did you test it?

The sync-callback behavior (streaming proceeds, warning logged) was executed against the v3 code with an offline generator.

Notes for the reviewer

Checklist

🤖 Generated with Claude Code

…cks in run_async, and SearchableToolset duplicate-name check

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@vercel

vercel Bot commented Jul 5, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
haystack-docs Ready Ready Preview, Comment Jul 9, 2026 7:59am

Request Review

…he other SearchableToolset docs

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@julian-risch julian-risch changed the title docs: document AsyncPipeline task cancellation, sync streaming callbacks, and SearchableToolset duplicate-name check docs: document AsyncPipeline task cancellation and sync streaming callbacks Jul 5, 2026
@sjrl
sjrl changed the base branch from v3 to main July 8, 2026 13:22
Resolve conflict in asyncpipeline.mdx: keep the new Error Handling and
Task Cancellation section, adopt main's corrected API reference link
(AsyncPipeline methods now live in pipeline.py on v3).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The AsyncPipeline page is being removed (AsyncPipeline merged into
Pipeline in 3.0), so the new content lands on the Pipelines concepts
page instead, and the streaming-callbacks guide links there.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
julian-risch added a commit that referenced this pull request Jul 8, 2026
…ted async docs

Takes over the pipelines.mdx additions from #11870 so the two PRs no
longer touch the same file.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
All pipelines.mdx edits are consolidated in #11871 to avoid cross-PR
conflicts; this PR now only adds the Sync and Async Callbacks section.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@julian-risch julian-risch changed the title docs: document AsyncPipeline task cancellation and sync streaming callbacks docs: document sync streaming callbacks in async contexts Jul 8, 2026
@julian-risch
julian-risch marked this pull request as ready for review July 8, 2026 19:51
@julian-risch
julian-risch requested a review from a team as a code owner July 8, 2026 19:51
@julian-risch
julian-risch requested review from anakin87 and removed request for a team July 8, 2026 19:51
@claude

claude Bot commented Jul 8, 2026

Copy link
Copy Markdown

Code review

No issues found. Checked for bugs and CLAUDE.md compliance.

1 similar comment
@claude

claude Bot commented Jul 8, 2026

Copy link
Copy Markdown

Code review

No issues found. Checked for bugs and CLAUDE.md compliance.

@anakin87 anakin87 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Just a minor comment

@anakin87 anakin87 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

👍

@julian-risch
julian-risch merged commit 9029a88 into main Jul 9, 2026
22 of 24 checks passed
@julian-risch
julian-risch deleted the docs/v3-simple-doc-updates branch July 9, 2026 08:00
julian-risch added a commit that referenced this pull request Jul 9, 2026
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants