Skip to content

Python: Make Executor type-system examples valid Python - #9257

Open
BlueRaddish wants to merge 1 commit into
microsoft:mainfrom
BlueRaddish:docs/oct11-executor-example-bodies
Open

BlueRaddish wants to merge 1 commit into
microsoft:mainfrom
BlueRaddish:docs/oct11-executor-example-bodies

Conversation

@BlueRaddish

Copy link
Copy Markdown
Contributor

Motivation & Context

The first three Executor type-system examples define async handlers whose bodies contain only a comment. Copying any example into Python raises IndentationError before it can demonstrate handler type discovery.

Description & Review Guide

  • What are the major changes? Add an ellipsis statement to each of the three illustrative handler bodies.
  • What is the impact of these changes? The examples become valid Python while preserving their existing annotations and explanatory comments. Extracting the actual examples and instantiating their executors verifies the documented input, message-output, and workflow-output types. All three fail compilation before the correction and all three compile and expose the expected types afterward.
  • What do you want reviewers to focus on? Whether each placeholder preserves the intended schematic example. Only documentation changes; executor implementation and public APIs are unchanged.

Related Issue

N/A - trivial change. Adding the missing statements is an obvious syntax correction to documentation examples, with no change to runtime behavior or design.

AI Assistance

  • No material AI assistance was used.
  • This is an AI-assisted contribution. I reviewed, understood, and verified all submitted content and accept responsibility for it.

AI assistance details: OpenAI Codex assisted with identifying the invalid examples, the documentation correction, offline example verification, and this description.

Contribution Checklist

  • The code builds clean without any errors or warnings
  • All unit tests pass, and I have added new tests where possible
  • The PR follows the Contribution Guidelines
  • This PR links to an agreed issue with no competing open PR, or the Related Issue section documents a trivial-change or repository-automation exception.
  • This is not a breaking change. If it is a breaking change, add the breaking change label (or add "[BREAKING]" to the title prefix, before or after any language prefix) — a workflow keeps the label and title prefix in sync automatically.

Copilot AI 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.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@agent-framework-automation agent-framework-automation Bot added the python Usage: [Issues, PRs], Target: Python label Oct 11, 2026
@eavanvalkenburg

Copy link
Copy Markdown
Member

/review

@github-actions github-actions Bot 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.

MAF Automated Review — Iteration 1

Result: No findings
Scope: full PR (1 commit(s)): 29ae09ee0e06
Model: gpt-5.6-sol

Overview

The PR adds inert ellipsis statements to three comment-only async handler bodies in the Executor class documentation, making each example valid Python without changing runtime code or public contracts. Handler discovery and type exposure remain annotation-driven, with existing tests covering input, message-output, and workflow-output type inference. No publishable Critical, High, or Medium issue is supported by the changed lines.

Reviewed the supplied pull-request change set across correctness, security/reliability, architecture, and failure behavior.
No publishable findings remained after source verification for this scope.

@eavanvalkenburg

Copy link
Copy Markdown
Member

/review

This branch was previously deployed

1 inactive deployment
github-app-auth — 29ae09ee Deployed Oct 11, 2026 by BlueRaddish via team_check #6513
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

python Usage: [Issues, PRs], Target: Python

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants