From ce38cc1b2213cb04972f3c64dea9bb19e14d5334 Mon Sep 17 00:00:00 2001
From: Rinat Minibaev <132935507+rinatmini@users.noreply.github.com>
Date: Fri, 18 Aug 2023 10:12:46 -0700
Subject: [PATCH] Documentation: Adds additional note for GetContactedRegions
method (#4042)
* Added small remark for GetContactedRegions method documentation
* Moved to remarks
---
Microsoft.Azure.Cosmos/src/Diagnostics/CosmosDiagnostics.cs | 3 +++
1 file changed, 3 insertions(+)
diff --git a/Microsoft.Azure.Cosmos/src/Diagnostics/CosmosDiagnostics.cs b/Microsoft.Azure.Cosmos/src/Diagnostics/CosmosDiagnostics.cs
index ad568475d..a82ef2ecc 100644
--- a/Microsoft.Azure.Cosmos/src/Diagnostics/CosmosDiagnostics.cs
+++ b/Microsoft.Azure.Cosmos/src/Diagnostics/CosmosDiagnostics.cs
@@ -80,6 +80,9 @@ namespace Microsoft.Azure.Cosmos
/// Gets the list of all regions that were contacted for a request
///
/// The list of tuples containing the Region name and the URI
+ ///
+ /// The returned list contains unique regions and doesn't guarantee ordering of the regions contacted from the first to the last
+ ///
public abstract IReadOnlyList<(string regionName, Uri uri)> GetContactedRegions();
}
}