Fix formatting and SDK references in documentation#112
Fix formatting and SDK references in documentation#112erjain wants to merge 9 commits intoMicrosoftLearning:mainfrom
Conversation
Corrected the reference to the Microsoft Foundry SDK in the tip section.
Updated folder paths in instructions for the exercise and corrected comment wording for clarity.
There was a problem hiding this comment.
Pull request overview
This PR fixes a repeated grammatical typo ("based on the for Microsoft Foundry SDK for Python") in the Tip sections of several lab instruction files. It also corrects a Labfiles folder path reference in one exercise file.
Changes:
- Removes the erroneous word "for" from the SDK Tip in four instruction files (
02-build-ai-agent.md,03-agent-custom-functions.md,03b-build-multi-agent-solution.md,Exercises/02-agent-custom-tools.md) - Updates the Labfiles path in
Exercises/02-agent-custom-tools.mdfrom02-agent-custom-toolsto03-agent-custom-tools(matching the actual directory) - Modifies a Python code comment in
Exercises/02-agent-custom-tools.mdto mention "input list"
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
Instructions/02-build-ai-agent.md |
Removes extraneous "for" from SDK Tip |
Instructions/03-agent-custom-functions.md |
Removes extraneous "for" from SDK Tip |
Instructions/03b-build-multi-agent-solution.md |
Removes extraneous "for" from SDK Tip |
Instructions/Exercises/02-agent-custom-tools.md |
Removes extraneous "for" from SDK Tip; corrects Labfiles folder path; modifies a Python code comment |
Note: Two additional files with the same "based on the for" typo were found outside the PR scope —
Instructions/06-multi-remote-agents-with-a2a.md:11andInstructions/Exercises/09-multi-remote-agents-with-a2a.md:13— and should be addressed in a follow-up.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ```python | ||
| # Create a list to hold function call outputs that will be sent back as input to the agent | ||
| # Create a input list to hold function call outputs that will be sent back as input to the agent |
There was a problem hiding this comment.
The code comment in the Python snippet was changed from # Create a list to hold function call outputs that will be sent back as input to the agent to # Create a input list to hold function call outputs that will be sent back as input to the agent. This introduces two problems:
- "a input" is grammatically incorrect — it should be "an input".
- This comment must exactly match the comment in the actual starter code file (
Labfiles/03-agent-custom-tools/Python/agent.py, line 35), which reads# Create a list to hold function call outputs that will be sent back as input to the agent. Students are instructed (line 313) to "Find the comment" in the starter code to know where to add the provided snippet. If the comment in the exercise instructions doesn't match the actual file, students won't be able to find it.
The comment should be reverted to the original: # Create a list to hold function call outputs that will be sent back as input to the agent.
There was a problem hiding this comment.
Copilot is right, it needs to exactly match the files
ivorb
left a comment
ivorb
left a comment
There was a problem hiding this comment.
I'm not opposed to some of these fixes, but I can't merge this as is. Please fix it if you'd like it merged, otherwise I'll make some of the typo fixes independently
| 1. Create a new folder and choose **Select as Repository Destination**, then open the cloned repository when prompted. | ||
|
|
||
| 1. In the Explorer view, navigate to the **Labfiles/02-agent-custom-tools/Python** folder to find the starter code for this exercise. | ||
| 1. In the Explorer view, navigate to the **Labfiles/03-agent-custom-tools/Python** folder to find the starter code for this exercise. |
There was a problem hiding this comment.
This is inaccurate, we have two versions of the labfiles for the old and new versions - the number needs to match the prefix of the instruction.
|
|
||
| ```python | ||
| # Create a list to hold function call outputs that will be sent back as input to the agent | ||
| # Create a input list to hold function call outputs that will be sent back as input to the agent |
There was a problem hiding this comment.
Copilot is right, it needs to exactly match the files
This pull request fixes a minor typo in several instructional files, improving clarity by correcting the phrasing in the "Tip" sections. The change removes the unnecessary word "for" from the description of the Microsoft Foundry SDK.
Documentation improvements:
Instructions/02-build-ai-agent.md,Instructions/03-agent-custom-functions.md, andInstructions/Exercises/02-agent-custom-tools.mdto read "based on the Microsoft Foundry SDK for Python" instead of "based on the for Microsoft Foundry SDK for Python". [1] [2] [3]Instructions/03b-build-multi-agent-solution.mdto read "based on the Foundry SDK for Python" instead of "based on the for Foundry SDK for Python".# Module: 00Lab/Demo: 00
Fixes # .
Changes proposed in this pull request: