From 8a4db54b41ed76a9f71c8dc5226fe05a183f17c7 Mon Sep 17 00:00:00 2001 From: Stephen Toub Date: Mon, 18 Nov 2024 07:44:27 -0500 Subject: [PATCH] Annotate private DebuggerDisplay props as DebuggerBrowsableState.Never (#5656) It's just noise. --- .../ChatCompletion/ChatResponseFormatJson.cs | 1 + .../ChatCompletion/RequiredChatToolMode.cs | 1 + .../Microsoft.Extensions.AI.Abstractions/Contents/DataContent.cs | 1 + .../Contents/FunctionCallContent.cs | 1 + .../Contents/FunctionResultContent.cs | 1 + .../Contents/UsageContent.cs | 1 + .../Microsoft.Extensions.AI.Abstractions/UsageDetails.cs | 1 + 7 files changed, 7 insertions(+) diff --git a/src/Libraries/Microsoft.Extensions.AI.Abstractions/ChatCompletion/ChatResponseFormatJson.cs b/src/Libraries/Microsoft.Extensions.AI.Abstractions/ChatCompletion/ChatResponseFormatJson.cs index e26c769ca62..23b6ff635a8 100644 --- a/src/Libraries/Microsoft.Extensions.AI.Abstractions/ChatCompletion/ChatResponseFormatJson.cs +++ b/src/Libraries/Microsoft.Extensions.AI.Abstractions/ChatCompletion/ChatResponseFormatJson.cs @@ -55,5 +55,6 @@ public override int GetHashCode() => typeof(ChatResponseFormatJson).GetHashCode(); /// Gets a string representing this instance to display in the debugger. + [DebuggerBrowsable(DebuggerBrowsableState.Never)] private string DebuggerDisplay => Schema ?? "JSON"; } diff --git a/src/Libraries/Microsoft.Extensions.AI.Abstractions/ChatCompletion/RequiredChatToolMode.cs b/src/Libraries/Microsoft.Extensions.AI.Abstractions/ChatCompletion/RequiredChatToolMode.cs index ef410ba24db..74858dfe89b 100644 --- a/src/Libraries/Microsoft.Extensions.AI.Abstractions/ChatCompletion/RequiredChatToolMode.cs +++ b/src/Libraries/Microsoft.Extensions.AI.Abstractions/ChatCompletion/RequiredChatToolMode.cs @@ -47,6 +47,7 @@ public RequiredChatToolMode(string? requiredFunctionName) // Equals/GetHashCode as well, which they likely won't. /// Gets a string representing this instance to display in the debugger. + [DebuggerBrowsable(DebuggerBrowsableState.Never)] private string DebuggerDisplay => $"Required: {RequiredFunctionName ?? "Any"}"; /// diff --git a/src/Libraries/Microsoft.Extensions.AI.Abstractions/Contents/DataContent.cs b/src/Libraries/Microsoft.Extensions.AI.Abstractions/Contents/DataContent.cs index e677bdcf36b..39d610a6dcb 100644 --- a/src/Libraries/Microsoft.Extensions.AI.Abstractions/Contents/DataContent.cs +++ b/src/Libraries/Microsoft.Extensions.AI.Abstractions/Contents/DataContent.cs @@ -196,6 +196,7 @@ public ReadOnlyMemory? Data } /// Gets a string representing this instance to display in the debugger. + [DebuggerBrowsable(DebuggerBrowsableState.Never)] private string DebuggerDisplay { get diff --git a/src/Libraries/Microsoft.Extensions.AI.Abstractions/Contents/FunctionCallContent.cs b/src/Libraries/Microsoft.Extensions.AI.Abstractions/Contents/FunctionCallContent.cs index ea3458fb5b6..b42c41e7cc8 100644 --- a/src/Libraries/Microsoft.Extensions.AI.Abstractions/Contents/FunctionCallContent.cs +++ b/src/Libraries/Microsoft.Extensions.AI.Abstractions/Contents/FunctionCallContent.cs @@ -97,6 +97,7 @@ public static FunctionCallContent CreateFromParsedArguments( } /// Gets a string representing this instance to display in the debugger. + [DebuggerBrowsable(DebuggerBrowsableState.Never)] private string DebuggerDisplay { get diff --git a/src/Libraries/Microsoft.Extensions.AI.Abstractions/Contents/FunctionResultContent.cs b/src/Libraries/Microsoft.Extensions.AI.Abstractions/Contents/FunctionResultContent.cs index b05553f16b8..2c9778e1d03 100644 --- a/src/Libraries/Microsoft.Extensions.AI.Abstractions/Contents/FunctionResultContent.cs +++ b/src/Libraries/Microsoft.Extensions.AI.Abstractions/Contents/FunctionResultContent.cs @@ -69,6 +69,7 @@ public FunctionResultContent(string callId, string name, object? result) public Exception? Exception { get; set; } /// Gets a string representing this instance to display in the debugger. + [DebuggerBrowsable(DebuggerBrowsableState.Never)] private string DebuggerDisplay { get diff --git a/src/Libraries/Microsoft.Extensions.AI.Abstractions/Contents/UsageContent.cs b/src/Libraries/Microsoft.Extensions.AI.Abstractions/Contents/UsageContent.cs index 22d86bd97cb..16e9d08b324 100644 --- a/src/Libraries/Microsoft.Extensions.AI.Abstractions/Contents/UsageContent.cs +++ b/src/Libraries/Microsoft.Extensions.AI.Abstractions/Contents/UsageContent.cs @@ -38,5 +38,6 @@ public UsageDetails Details } /// Gets a string representing this instance to display in the debugger. + [DebuggerBrowsable(DebuggerBrowsableState.Never)] private string DebuggerDisplay => _details.DebuggerDisplay; } diff --git a/src/Libraries/Microsoft.Extensions.AI.Abstractions/UsageDetails.cs b/src/Libraries/Microsoft.Extensions.AI.Abstractions/UsageDetails.cs index f12ed819a6e..1e836da5045 100644 --- a/src/Libraries/Microsoft.Extensions.AI.Abstractions/UsageDetails.cs +++ b/src/Libraries/Microsoft.Extensions.AI.Abstractions/UsageDetails.cs @@ -23,6 +23,7 @@ public class UsageDetails public AdditionalPropertiesDictionary? AdditionalProperties { get; set; } /// Gets a string representing this instance to display in the debugger. + [DebuggerBrowsable(DebuggerBrowsableState.Never)] internal string DebuggerDisplay { get