Skip to content

.NET: Fix documented default for ChatHistoryMemoryProviderOptions.FunctionToolDescription - #7530

Open
dfedoryshchev wants to merge 1 commit into
microsoft:mainfrom
dfedoryshchev:fix/chat-history-memory-provider-doc-default
Open

.NET: Fix documented default for ChatHistoryMemoryProviderOptions.FunctionToolDescription#7530
dfedoryshchev wants to merge 1 commit into
microsoft:mainfrom
dfedoryshchev:fix/chat-history-memory-provider-doc-default

Conversation

@dfedoryshchev

Copy link
Copy Markdown

Motivation & Context

ChatHistoryMemoryProviderOptions.FunctionToolDescription documents a default that is not the one the provider applies, so IntelliSense and the published XML docs show the wrong string.

Description & Review Guide

The <value> text now quotes ChatHistoryMemoryProvider.DefaultFunctionToolDescription verbatim. Sibling TextSearchProviderOptions.FunctionToolDescription already matches its own default the same way. Comment only, no behavior change.

Related Issue

N/A - documentation only; CONTRIBUTING allows skipping the issue step for trivial changes.

Contribution Checklist

  • The code builds clean without any errors or warnings
  • All unit tests pass, and I have added new tests where possible
  • The PR follows the Contribution Guidelines
  • This is not a breaking change.

Copilot AI lite review requested due to automatic review settings August 5, 2026 17:33
@agent-framework-automation agent-framework-automation Bot added the .NET Usage: [Issues, PRs], Target: .Net label Aug 5, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the .NET API documentation for ChatHistoryMemoryProviderOptions.FunctionToolDescription so that the XML docs/IntelliSense reflect the actual default description string used by ChatHistoryMemoryProvider.

Changes:

  • Corrected the <value> XML doc text for ChatHistoryMemoryProviderOptions.FunctionToolDescription to match the provider’s applied default string.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

.NET Usage: [Issues, PRs], Target: .Net

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants