From 245a2b7c81f89e5a775137034f2a6100194b6fd3 Mon Sep 17 00:00:00 2001 From: feizhuzheng Date: Sat, 29 Aug 2026 10:01:25 +0800 Subject: [PATCH] Python: fix typos in docs and handoff docstring --- python/CODING_STANDARD.md | 2 +- python/DEV_SETUP.md | 2 +- python/packages/ollama/README.md | 2 +- .../orchestrations/agent_framework_orchestrations/_handoff.py | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/python/CODING_STANDARD.md b/python/CODING_STANDARD.md index 9081e52b87b..e1324bdbdc3 100644 --- a/python/CODING_STANDARD.md +++ b/python/CODING_STANDARD.md @@ -27,7 +27,7 @@ Public modules must include a module-level docstring, including `__init__.py` fi ## Type Annotations -We use typing as a helper, it is not a goal in and of itself, so be pragmatic about where and when to strictly type, versus when to use a targetted cast or ignore. +We use typing as a helper, it is not a goal in and of itself, so be pragmatic about where and when to strictly type, versus when to use a targeted cast or ignore. In general, the public interfaces of our classes, are important to get right, internally it is okay to have loosely typed code, as long as tests cover the code itself. This includes making a conscious choice when to program defensively, you can always do `getattr(item, 'attribute')` but that might end up causing you issues down the road because the type of `item` in this case, should have that attribute and if it doesn't it points to a larger issue, so if the type is expected to have that attribute, you should diff --git a/python/DEV_SETUP.md b/python/DEV_SETUP.md index 479d5f47749..4d5edc8d71a 100644 --- a/python/DEV_SETUP.md +++ b/python/DEV_SETUP.md @@ -68,7 +68,7 @@ uv run poe install uv run poe prek-install ``` -Alternatively, you can reinstall the venv, pacakges, dependencies and prek hooks with a single command (but this requires poe in the current env), this is especially useful if you want to switch python versions: +Alternatively, you can reinstall the venv, packages, dependencies and prek hooks with a single command (but this requires poe in the current env), this is especially useful if you want to switch python versions: ```bash uv run poe setup -p 3.13 diff --git a/python/packages/ollama/README.md b/python/packages/ollama/README.md index d0bdf58cf3c..3c9b54d192d 100644 --- a/python/packages/ollama/README.md +++ b/python/packages/ollama/README.md @@ -8,6 +8,6 @@ pip install agent-framework-ollama --pre and see the [README](https://github.com/microsoft/agent-framework/tree/main/python/README.md) for more information. -# Run samples with the Ollama Conector +# Run samples with the Ollama Connector You can find samples how to run the connector in the [Ollama provider samples](../../samples/02-agents/providers/ollama). diff --git a/python/packages/orchestrations/agent_framework_orchestrations/_handoff.py b/python/packages/orchestrations/agent_framework_orchestrations/_handoff.py index b2db50f76aa..9403a4ec2f9 100644 --- a/python/packages/orchestrations/agent_framework_orchestrations/_handoff.py +++ b/python/packages/orchestrations/agent_framework_orchestrations/_handoff.py @@ -9,7 +9,7 @@ user input -> Agent A -> Agent B -> Agent C -> Agent A -> ... -> output -Depending of wether request info is enabled, the flow may include user input (except when an agent hands off): +Depending on whether request info is enabled, the flow may include user input (except when an agent hands off): user input -> [Agent A -> Request info] -> [Agent B -> Request info] -> [Agent C -> ... -> output