Python: docs: correct three README errors found by following them - #8822
Merged
Eduard van Valkenburg (eavanvalkenburg) merged 1 commit intoSep 29, 2026
Conversation
The root quickstart reads FOUNDRY_MODEL_DEPLOYMENT_NAME, which is a variable in our dotnet integration workflow but not one FoundryChatClient reads -- it uses FOUNDRY_MODEL, as python/README.md already says. Uncommenting the line as written raises "Model is required". 01-get-started marks FOUNDRY_MODEL "optional, defaults to gpt-4o". It has no default; the constructor raises when it is unset, which test_foundry_chat_client.py pins. Only the comment is wrong. 01-get-started also refers to a Sample 08 that does not exist here. The hosting samples moved to the durable-extension repo, which the same file already links.
fei (feiiiiii5)
requested review from
SergeyMenshykh,
Tao Chen (TaoChenOSU),
Vincent Biret (baywet),
Eduard van Valkenburg (eavanvalkenburg),
Giles Odigwe (giles17),
Jose Alvarez (jpalvarezl),
Evan Mattson (moonbox3),
Peter Ibekwe (peibekwe),
Roger Barreto (rogerbarreto) and
westey (westey-m)
as code owners
September 29, 2026 07:30
Contributor
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
All documentation changes align with the client implementation, tests, and current sample layout.
Review effort: Balanced
Findings: None
What changed in this PR
Corrects Python quickstart documentation to match FoundryChatClient behavior and current sample structure.
Changes:
- Uses the correct
FOUNDRY_MODELenvironment variable. - Removes an incorrect default-model claim and stale Sample 08 reference.
| File | Description |
|---|---|
README.md |
Corrects the Foundry model environment variable. |
python/samples/01-get-started/README.md |
Corrects prerequisites and removes an obsolete sample reference. |
💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.
Eduard van Valkenburg (eavanvalkenburg)
approved these changes
Sep 29, 2026
Eduard van Valkenburg (eavanvalkenburg)
left a comment
Member
There was a problem hiding this comment.
fei (@feiiiiii5) Thanks — the documentation corrections match the current implementation, the dedicated review found no issues, and all reported checks are green.
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.
Motivation & Context
Found by installing the published package in a clean environment and following the docs verbatim, in the order a new user would. Three README errors, none of which need a code change. Details and reproduction in #8821.
README.md:131readsFOUNDRY_MODEL_DEPLOYMENT_NAME.FoundryChatClientreadsFOUNDRY_MODEL(_chat_client.py:211setsenv_prefix="FOUNDRY_";:220raisesValueError: Model is required. Set via 'model' parameter or 'FOUNDRY_MODEL'). The wrong name is a real variable in.github/workflows/dotnet-integration-tests.yml:112, which is likely why it survived — it is the pipeline's own, not the client's.python/README.md:58already has it right, so the two READMEs disagree.python/samples/01-get-started/README.mdmarkedFOUNDRY_MODEL"optional, defaults to gpt-4o". There is no default; unset, the constructor raises. The code is deliberately so —test_foundry_chat_client.py:345pins it withpytest.raises(ValueError, match="Model is required"). I removed only the wrong comment.Sample 08that does not exist in this directory (the table lists 1–7, and there is no08_*underpython/samples/). The hosting samples moved to the durable-extension repo, which the same file already links further down, so I deleted the stale line rather than rewording it.Description & Review Guide
ValueError: Model is requiredinstead of a working first run. A reader who believesFOUNDRY_MODELis optional and skips it also gets that error — which is how05_end_to_end.pyfails, since it passes nomodelof its own.Sample 08line is right, as opposed to restoring the sample or rewording the line. That is the only judgement call; the other two are corrections with the code as the authority.How this was verified. Clean venv on Python 3.13,
uv pip install agent-framework→ 1.19.0, then the root quickstart in order. TheValueErrorfor the unset model reproduces twice; withFOUNDRY_MODELset the same snippet runs. I have not executed samples 01–05 end to end — they stop atCredentialUnavailableError('Azure CLI not found on path'), the documentedaz loginprerequisite.I have not run the Python test suite for this change, since it touches only two Markdown files.
Related Issue
Fixes #8821
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.