Python: [Work in progress] Minor fixes to code comments - #8985
Draft
Darren Cohen (dargilco) wants to merge 8 commits into
Draft
Darren Cohen (dargilco) wants to merge 8 commits into
Darren Cohen (dargilco) wants to merge 8 commits into
Conversation
Darren Cohen (dargilco)
deployed
to
github-app-auth
October 2, 2026 18:15 — with 
GitHub Actions
Active
Darren Cohen (dargilco)
deployed
to
github-app-auth
October 2, 2026 18:15 — with
GitHub Actions
Active
Darren Cohen (dargilco)
deployed
to
github-app-auth
October 2, 2026 18:21 — with
GitHub Actions
Active
Darren Cohen (dargilco)
deployed
to
github-app-auth
October 2, 2026 18:21 — with
GitHub Actions
Active
Darren Cohen (dargilco)
deployed
to
github-app-auth
October 2, 2026 18:21 — with
GitHub Actions
Active
Darren Cohen (dargilco)
deployed
to
github-app-auth
October 2, 2026 18:22 — with
GitHub Actions
Active
Darren Cohen (dargilco)
deployed
to
github-app-auth
October 2, 2026 18:23 — with
GitHub Actions
Active
Contributor
There was a problem hiding this comment.
Warning
Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.
Copilot review overview
Review effort: Lite
Findings: 3
Open (3)
response_stream.py, but this PR changes… · New|- ...).… · New
What changed in this PR
This PR primarily corrects grammar in Python samples/docstrings (notably “a Agent” → “an Agent”) and adjusts the markdown flow in the response_stream.py sample.
Changes:
- Fixes article/grammar issues across samples, packages, and tests (“a agent/Agent” → “an agent/Agent”).
- Reorders/rewraps the “Pattern 3: Combined Usage” explanation in
response_stream.py. - Minor docstring wording cleanup in multiple modules.
| File | Description |
|---|---|
| python/samples/03-workflows/agents/group_chat_workflow_as_agent.py | Grammar fix in sample description bullet. |
| python/samples/03-workflows/agents/custom_agent_executors.py | Grammar fix in Writer docstring bullet list. |
| python/samples/02-agents/response_stream.py | Reflows markdown around “Pattern 3” and “Chaining” explanations. |
| python/samples/02-agents/providers/anthropic/anthropic_skills.py | Comment grammar fix. |
| python/samples/02-agents/observability/workflow_observability.py | Docstring grammar fix. |
| python/packages/orchestrations/agent_framework_orchestrations/_magentic.py | Docstring grammar fix. |
| python/packages/declarative/agent_framework_declarative/_workflows/_factory.py | Docstring grammar fix. |
| python/packages/declarative/agent_framework_declarative/_loader.py | Docstring grammar fixes across multiple factory methods. |
| python/packages/core/agent_framework/_workflows/_typing_utils.py | Docstring grammar fix. |
| python/packages/core/agent_framework/_agents.py | Docstring grammar fix for Agent initializers. |
| python/packages/ag-ui/tests/ag_ui/test_tooling.py | Test helper docstring grammar fix. |
💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.
| @@ -118,18 +118,16 @@ | |||
| - You get the complete response without ever seeing individual updates | |||
|
|
|||
| print(update.text) # See each update | ||
| final = await response_stream.get_final_response() # Get the aggregated result | ||
| ``` | ||
| When you first iterate the stream and then call `get_final_response()`, the following occurs: |
Darren Cohen (dargilco)
deployed
to
github-app-auth
October 2, 2026 19:20 — with
GitHub Actions
Active
Darren Cohen (dargilco)
deployed
to
github-app-auth
October 2, 2026 19:22 — with
GitHub Actions
Active
Darren Cohen (dargilco)
deployed
to
github-app-auth
October 2, 2026 19:29 — with
GitHub Actions
Active
Darren Cohen (dargilco)
deployed
to
github-app-auth
October 2, 2026 19:30 — with
GitHub Actions
Active
Darren Cohen (dargilco)
deployed
to
github-app-auth
October 2, 2026 19:39 — with
GitHub Actions
Active
Darren Cohen (dargilco)
deployed
to
github-app-auth
October 2, 2026 19:40 — with
GitHub Actions
Active
Darren Cohen (dargilco)
deployed
to
github-app-auth
October 2, 2026 19:56 — with
GitHub Actions
Active
Darren Cohen (dargilco)
deployed
to
github-app-auth
October 2, 2026 19:56 — with
GitHub Actions
Active
Darren Cohen (dargilco)
deployed
to
github-app-auth
October 2, 2026 20:13 — with
GitHub Actions
Active
This branch was successfully 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.
python\samples\02-agents\response_stream.pyMotivation & Context
Description & Review Guide
Related Issue
Fixes #
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.