Skip to content

Python: Fix stale run commands in sample headers - #9601

Draft
Naveen Chatlapalli (1aifanatic) wants to merge 1 commit into
microsoft:mainfrom
1aifanatic:contrib/python-sample-header-run-paths
Draft

Naveen Chatlapalli (1aifanatic) wants to merge 1 commit into
microsoft:mainfrom
1aifanatic:contrib/python-sample-header-run-paths

Conversation

@1aifanatic

Copy link
Copy Markdown
Contributor

Motivation & Context

Three Python samples have a "Run with" header comment that points to a file that does not exist, so copying the command fails:

  • samples/autogen-migration/single_agent/03_agent_thread_and_stream.py → .../03_assistant_agent_thread_and_stream.py
  • samples/02-agents/embeddings/openai_embeddings_on_azure.py → .../azure_openai_embeddings.py
  • samples/05-end-to-end/chatkit-integration/app.py → samples/demos/chatkit-integration/app.py

Description & Review Guide

  • What are the major changes? Each header now points to the file itself.
  • What is the impact of these changes? Comments only.
  • What do you want reviewers to focus on? Nothing special.

I found these by checking every uv run samples/... path in sample headers against the tree. The M365 sample had the same stale samples/demos path, and it is fixed in its own PR for #9595. The ChatKit change touches only the header comment, so it does not overlap with #9579.

Related Issue

N/A - trivial change: each command points to a file that does not exist, and the correct path is the file containing the comment, so the desired result is not in dispute.

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: Claude Code helped write the script that found the stale paths, make the edits, and draft 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.

🤖 Generated with Claude Code

Three samples' header comments pointed at files that no longer exist
(renamed or moved out of samples/demos). Point them at the files
themselves.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Copilot AI balanced review requested due to automatic review settings October 22, 2026 12:54
@agent-framework-automation agent-framework-automation Bot added the python Usage: [Issues, PRs], Target: Python label Oct 22, 2026

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.

🟢 Approval recommended

All three corrected paths match their containing files, and the comment-only changes have no unresolved issues.

No open issues 🎉

What changed in this PR

Corrects stale run commands in three Python sample headers so each command points to its containing file.

Changes:

  • Fixes filenames in the AutoGen migration and Azure embeddings sample comments.
  • Updates the ChatKit header comment to use 05-end-to-end instead of demos.
  • Changes comments only; executable code is unchanged.
File Description
python/​samples/​autogen-migration/​single_agent/​03_agent_thread_and_stream.py Corrects the filename in the run command.
python/​samples/​05-end-to-end/​chatkit-integration/​app.py Corrects the sample directory in the run command.
python/​samples/​02-agents/​embeddings/​openai_embeddings_on_azure.py Corrects the filename in the run command.

Review effort: Balanced

This branch was successfully deployed

1 active deployment
github-app-auth — 33f91fab Deployed Oct 22, 2026 by 1aifanatic via team_check #7248
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.

2 participants