From d1c4f20e9e5e0eda2ee94ab597bbb0901e2afee9 Mon Sep 17 00:00:00 2001
From: Steve Gordon <sgordon@hotmail.co.uk>
Date: Wed, 30 Oct 2024 08:49:55 +0000
Subject: [PATCH] Update comments

---
 src/Elastic.Transport/Responses/TransportResponse.cs | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/src/Elastic.Transport/Responses/TransportResponse.cs b/src/Elastic.Transport/Responses/TransportResponse.cs
index a23f2e2..4e7f4a8 100644
--- a/src/Elastic.Transport/Responses/TransportResponse.cs
+++ b/src/Elastic.Transport/Responses/TransportResponse.cs
@@ -40,9 +40,20 @@ public override string ToString() => ApiCallDetails?.DebugInformation
 	/// <summary>
 	/// Allows other disposable resources to to be disposed along with the response.
 	/// </summary>
+	/// <remarks>
+	/// While it's slightly confusing to have this on the base type which is NOT IDisposable, it avoids
+	/// specialised type checking in the request invoker and response builder code. Currently, only used by
+	/// StreamResponse and kept internal. If we later make this public, we might need to refine this.
+	/// </remarks>
 	[JsonIgnore]
 	internal IEnumerable<IDisposable>? LinkedDisposables { get; set; }
 
+	/// <summary>
+	/// Allows the response to identify that the response stream should NOT be automatically disposed.
+	/// </summary>
+	/// <remarks>
+	/// Currently only used by StreamResponse and therefore internal.
+	/// </remarks>
 	[JsonIgnore]
 	internal virtual bool LeaveOpen { get; } = false;
 }