Repository navigation
Python: Correct HandoffBuilder output selection documentation - #9717
Merged
Eduard van Valkenburg (eavanvalkenburg) merged 1 commit intoOct 27, 2026
Conversation
LI (ktz03)
temporarily deployed
to
github-app-auth
October 26, 2026 15:09 — with
GitHub Actions
Inactive
LI (ktz03)
temporarily deployed
to
github-app-auth
October 26, 2026 15:10 — with
GitHub Actions
Inactive
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The docstring-only changes agree with the existing selection behavior and tests, with no unresolved findings.
No open issues 🎉
What changed in this PR
Corrects two HandoffBuilder docstrings to distinguish default output behavior from configurable participant selection. The selection API, runtime behavior, and test assertions remain unchanged.
Changes:
- Clarifies that per-agent workflow output is the default and documents the existing output selectors.
- Updates the default-selection test’s docstring to remove the claim that handoff has no intermediate output channel.
| File | Description |
|---|---|
python/packages/orchestrations/tests/test_orchestration_intermediate_vs_terminal.py |
Clarifies the default-selection test’s docstring without changing assertions. |
python/packages/orchestrations/agent_framework_orchestrations/_handoff.py |
Documents default output behavior and configurable participant selection. |
Review effort: Balanced
Eduard van Valkenburg (eavanvalkenburg)
approved these changes
Oct 27, 2026
This branch was previously deployed
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.
Motivation & Context
HandoffBuilderdocumentsoutput_fromandintermediate_output_from, but its class overview still says that handoff has no intermediate output channel. That contradicts the existing selection API and can mislead readers configuring which participants appear in each event stream.Description & Review Guide
build(), and the existing default/custom-selection tests.On Windows with Python 3.14.3, both modified files parse and compile. Their ASTs are identical after removing docstrings. Ruff 0.17.1 check and format-check pass for both files with the repository configurations. No SDK imports, workflow execution, unit tests, package build, model or cloud calls were run.
Related Issue
N/A - trivial change. This corrects an explicit contradiction between two docstrings and the already implemented API in the same class; it introduces no API, behavior, or design choice. Related original implementation: #5623.
AI Assistance
AI assistance details: Documentation and PR description.
Contribution Checklist
breaking changelabel (or add "[BREAKING]" to the title prefix, before or after any language prefix) — a workflow keeps the label and title prefix in sync automatically.