Skip to content

Python: Fix sample README run commands that reference missing files - #9580

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

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

Conversation

@1aifanatic

Copy link
Copy Markdown
Contributor

Motivation & Context

Two sample READMEs tell readers to run files that do not exist, so copying the documented command fails with No such file or directory:

  • python/samples/02-agents/context_providers/azure_ai_search/README.md runs azure_ai_with_search_context_semantic.py and azure_ai_with_search_context_agentic.py. The files in that folder are search_context_semantic.py and search_context_agentic.py, which is how the same README's table already links them. The agentic sample's docstring also points to the old semantic filename.
  • python/samples/02-agents/declarative/README.md lists python openai_responses_agent.py under "Running", but the sample is openai_agent.py, which is how section 5 of the same README already links it.

Description & Review Guide

  • What are the major changes? Correct the three filenames in the two READMEs' run commands and the one stale filename in the search_context_agentic.py docstring.
  • What is the impact of these changes? Documentation only. The commands now match the files in each folder.
  • What do you want reviewers to focus on? Nothing beyond confirming the filenames.

I found these by checking every python/uv run command in sample READMEs against the files on disk. After this change, no references to azure_ai_with_search_context* or openai_responses_agent.py remain under python/samples.

Related Issue

N/A - trivial change: these are broken file references in documentation, and each correct name is already used elsewhere in the same README, 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 broken run commands, 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

The Azure AI Search context provider README told readers to run
azure_ai_with_search_context_{semantic,agentic}.py, and the agentic
sample's docstring pointed to the old semantic filename; the files are
search_context_{semantic,agentic}.py. The declarative agents README
listed openai_responses_agent.py, but the sample is openai_agent.py.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

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 corrected references match existing files, and the documentation-only changes have no unresolved issues.

No open issues 🎉

What changed in this PR

Corrects broken filename references in Python sample documentation without changing executable behavior.

Changes:

  • Fixes three run commands across two READMEs.
  • Updates the agentic search sample’s docstring to reference the semantic sample’s current filename.
File Description
python/​samples/​02-agents/​declarative/​README.md Corrects the OpenAI sample run command.
python/​samples/​02-agents/​context_providers/​azure_ai_search/​search_context_agentic.py Corrects a filename in the docstring.
python/​samples/​02-agents/​context_providers/​azure_ai_search/​README.md Corrects semantic and agentic sample run commands.

Review effort: Balanced

@agent-framework-automation agent-framework-automation Bot added documentation Usage: [Issues, PRs], Target: documentation in the code base and learn docs python Usage: [Issues, PRs], Target: Python labels Oct 21, 2026

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.

The corrected commands and docstring references all match the files present in the sample directories. This is a focused documentation fix with no behavioral concerns.

This branch was successfully deployed

1 active deployment
github-app-auth — 02685fc2 Deployed Oct 21, 2026 by 1aifanatic via team_check #7164
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Usage: [Issues, PRs], Target: documentation in the code base and learn docs python Usage: [Issues, PRs], Target: Python

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants