Repository navigation
Python: docs: remove duplicated words in comments, samples, and ADRs - #14758
Open
NingLin Liu (ninglinLiu) wants to merge 1 commit into
Open
NingLin Liu (ninglinLiu) wants to merge 1 commit into
NingLin Liu (ninglinLiu) wants to merge 1 commit into
Conversation
NingLin Liu (ninglinLiu)
temporarily deployed
to
github-app-auth
November 9, 2026 00:42 — with
GitHub Actions
Inactive
NingLin Liu (ninglinLiu)
force-pushed
the
docs/fix-duplicated-words
branch
from
November 9, 2026 00:43
94284ec to
55832b0
Compare
NingLin Liu (ninglinLiu)
deployed
to
github-app-auth
November 9, 2026 00:43 — with
GitHub Actions
Active
Contributor
There was a problem hiding this comment.
🔵 Needs a closer look
Missing regression tests for early-closing synchronous and asynchronous streams leave the underlying generators’ cleanup, including awaited async cleanup, unverified.
No open issues 🎉
What changed in this PR
This PR removes duplicated words across Semantic Kernel comments, sample documentation, and architecture decision records. It also introduces a Python stream-cleanup behavior change beyond the stated documentation scope.
Changes:
- Correct repeated words in Python docstrings, C# test comments, READMEs, and decision records.
- Correct wording in an agent-selection sample prompt.
- Explicitly close underlying synchronous and asynchronous generators when exiting stream iteration.
| File | Description |
|---|---|
| python/semantic_kernel/functions/kernel_function.py | Corrects docstrings and adds explicit generator cleanup. |
| python/semantic_kernel/core_plugins/sessions_python_tool/README.md | Removes repeated wording in token configuration instructions. |
| python/samples/getting_started_with_processes/README.md | Removes repeated words in process descriptions. |
| python/samples/getting_started_with_agents/chat_completion/step07_kernel_function_strategies.py | Corrects wording in the selection prompt. |
| python/samples/demos/telemetry/README.md | Corrects dashboard instructions. |
| dotnet/src/SemanticKernel.UnitTests/TemplateEngine/Blocks/CodeBlockTests.cs | Removes repeated words in assertion comments only. |
| dotnet/src/SemanticKernel.UnitTests/Functions/FunctionResultTests.cs | Corrects an assertion comment only. |
| docs/decisions/0072-agents-with-memory.md | Corrects service-state wording. |
| docs/decisions/0054-processes.md | Corrects runtime-description wording. |
| docs/decisions/0048-agent-chat-serialization.md | Removes repeated words in restoration descriptions. |
| docs/decisions/0041-function-call-content.md | Corrects wording about a proposed exception property. |
| docs/decisions/0035-skfunction-type-descriptions.md | Removes repeated words in schema descriptions. |
| docs/decisions/0021-json-serializable-custom-types.md | Corrects serialization-description wording. |
Review effort: Balanced
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.
Remove duplicated words such as
the theandof ofin Python/C# comments, sample docs, and a few architecture decision records.