Documentation: Adds additional note for GetContactedRegions method (#…

…4042) * Added small remark for GetContactedRegions method documentation * Moved to remarks
Azure · Aug 18, 2023 · ce38cc1 · ce38cc1
1 parent 48af69e
commit ce38cc1
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/Microsoft.Azure.Cosmos/src/Diagnostics/CosmosDiagnostics.cs b/Microsoft.Azure.Cosmos/src/Diagnostics/CosmosDiagnostics.cs
@@ -80,6 +80,9 @@ public virtual int GetFailedRequestCount()
         /// Gets the list of all regions that were contacted for a request
         /// </summary>
         /// <returns>The list of tuples containing the Region name and the URI</returns>
+        /// <remarks>
+        /// The returned list contains unique regions and doesn't guarantee ordering of the regions contacted from the first to the last
+        /// </remarks>
         public abstract IReadOnlyList<(string regionName, Uri uri)> GetContactedRegions();
     }
 }