Documentation: Fixes Database.ReadAsync description (#3457)

* Documentation: Modify retry time to timespan Modify retry time in seconds to timespan of parameter maxRetryWaitTimeOnThrottledRequests (Method: [WithThrottlingRetryOptions](https://docs.microsoft.com/en-us/dotnet/api/microsoft.azure.cosmos.fluent.cosmosclientbuilder.withthrottlingretryoptions?view=azure-dotnet#feedback)) Resolves Azure/azure-sdk-for-net#29567 * Documentation: Fixes DeleteItemAsync Example Documentation: Fixes DeleteItemAsync Example * Documentation: Fixes ItemRequestOptions Example Documentation: Fixes ItemRequestOptions Example * Documentation:Update Database.ReadAsync description Documentation: Update Database.ReadAsync description * Documentation: Update Database.ReadAsync description Documentation: Update Database.ReadAsync description * Documentation: Updated ToStreamIterator example Documentation: Updated ToStreamIterator example * Modified StreamIterator section * Update Microsoft.Azure.Cosmos/src/Resource/Database/Database.cs Co-authored-by: Matias Quaranta <ealsur@users.noreply.github.com> * Remarks correction * Revert the StreamIterator changes Revert the StreamIterator changes Co-authored-by: Matias Quaranta <ealsur@users.noreply.github.com> Co-authored-by: Kiran Kumar Kolli <kirankk@microsoft.com>
Azure · Mar 1, 2023 · 0088c2f · 0088c2f
1 parent 462a2c4
commit 0088c2f
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/Microsoft.Azure.Cosmos/src/Linq/CosmosLinqExtensions.cs b/Microsoft.Azure.Cosmos/src/Linq/CosmosLinqExtensions.cs
@@ -186,7 +186,7 @@ public static FeedIterator<T> ToFeedIterator<T>(this IQueryable<T> query)
  /// <code language="c#">
  /// <![CDATA[
  /// IOrderedQueryable<ToDoActivity> linqQueryable = this.Container.GetItemLinqQueryable<ToDoActivity>();
- /// using (FeedIterator setIterator = linqQueryable.Where(item => (item.taskNum < 100)).ToFeedIterator()
+ /// using (FeedIterator setIterator = linqQueryable.Where(item => (item.taskNum < 100)).ToStreamIterator())
  /// ]]>
  /// </code>
  /// </example>

diff --git a/Microsoft.Azure.Cosmos/src/Resource/Database/Database.cs b/Microsoft.Azure.Cosmos/src/Resource/Database/Database.cs
@@ -31,15 +31,18 @@ public abstract class Database
  /// </summary>
  public abstract CosmosClient Client { get; }
 
- /// <summary>
- /// Reads a <see cref="DatabaseProperties"/> from the Azure Cosmos service as an asynchronous operation.
+ /// <summary> 
+ /// Reads a <see cref="DatabaseResponse"/> from the Azure Cosmos service as an asynchronous operation.
  /// </summary>
  /// <param name="requestOptions">(Optional) The options for the request.</param>
  /// <param name="cancellationToken">(Optional) <see cref="CancellationToken"/> representing request cancellation.</param>
  /// <returns>
  /// A <see cref="Task"/> containing a <see cref="DatabaseResponse"/> which wraps a <see cref="DatabaseProperties"/> containing the read resource record.
  /// </returns>
  /// <exception>https://aka.ms/cosmosdb-dot-net-exceptions</exception>
+ /// <remarks>
+ /// <see cref="DatabaseResponse.Resource"/> contains the <see cref="DatabaseProperties"/> that include the resource information.
+ /// </remarks>
  /// <example>
  /// <code language="c#">
  /// <![CDATA[