Skip to content

Python: docs(typing): add return type and docstring to store_results in utils/chat.py#12910

Merged
TaoChenOSU merged 7 commits into
microsoft:mainfrom
ajeet214:patch-1
Sep 3, 2025
Merged

Python: docs(typing): add return type and docstring to store_results in utils/chat.py#12910
TaoChenOSU merged 7 commits into
microsoft:mainfrom
ajeet214:patch-1

Conversation

@ajeet214

@ajeet214 ajeet214 commented Aug 11, 2025

Copy link
Copy Markdown
Contributor

Summary

  • Added explicit return type -> ChatHistory to store_results.
  • Added detailed docstring explaining parameters, return type, and behavior.

Why

  • Improves static analysis, IDE support, and code readability.
  • Makes the function self-documenting for new contributors.

Testing

  • No changes to runtime behavior.
  • Existing test suite passes locally.

Motivation and Context

Description

Contribution Checklist

## Summary
- Added explicit return type `-> ChatHistory` to `store_results`.
- Added detailed docstring explaining parameters, return type, and behavior.

## Why
- Improves static analysis, IDE support, and code readability.
- Makes the function self-documenting for new contributors.

## Testing
- No changes to runtime behavior.
- Existing test suite passes locally.
@ajeet214 ajeet214 requested a review from a team as a code owner August 11, 2025 14:10
@moonbox3 moonbox3 added the python Pull requests for the Python Semantic Kernel label Aug 11, 2025
@github-actions github-actions Bot changed the title docs(typing): add return type and docstring to store_results in utils/chat.py Python: docs(typing): add return type and docstring to store_results in utils/chat.py Aug 11, 2025
@moonbox3

moonbox3 commented Aug 14, 2025

Copy link
Copy Markdown
Collaborator

Python Test Coverage

Python Test Coverage Report •
FileStmtsMissCoverMissing
utils
   chat.py60100% 
TOTAL27111472782% 

Python Unit Test Overview

Tests Skipped Failures Errors Time
3715 22 💤 0 ❌ 0 🔥 1m 40s ⏱️

@TaoChenOSU TaoChenOSU enabled auto-merge September 3, 2025 17:01
@TaoChenOSU TaoChenOSU added this pull request to the merge queue Sep 3, 2025
Merged via the queue into microsoft:main with commit ea564cf Sep 3, 2025
28 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

python Pull requests for the Python Semantic Kernel

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants