Documentation: Fixes method descriptions with sql query text vs defin…

…ition (#3024) * Fix method descriptions with sql query text vs definition * Fix descriptions in a couple more places
Azure · Feb 10, 2022 · d7b9546 · d7b9546
1 parent 4ca4a9b
commit d7b9546
Show file tree

Hide file tree

Showing 7 changed files with 14 additions and 28 deletions.
diff --git a/Microsoft.Azure.Cosmos/src/CosmosClient.cs b/Microsoft.Azure.Cosmos/src/CosmosClient.cs
@@ -889,7 +889,6 @@ public virtual FeedIterator GetDatabaseQueryStreamIterator(
 
  /// <summary>
  /// This method creates a query for databases under an Cosmos DB Account using a SQL statement. It returns a FeedIterator.
- /// For more information on preparing SQL statements with parameterized values, please see <see cref="QueryDefinition"/> overload.
  /// </summary>
  /// <param name="queryText">The cosmos SQL query text.</param>
  /// <param name="continuationToken">The continuation token in the Azure Cosmos DB service.</param>
@@ -942,7 +941,6 @@ public virtual FeedIterator<T> GetDatabaseQueryIterator<T>(
 
  /// <summary>
  /// This method creates a query for databases under an Cosmos DB Account using a SQL statement. It returns a FeedIterator.
- /// For more information on preparing SQL statements with parameterized values, please see <see cref="QueryDefinition"/> overload.
  /// </summary>
  /// <param name="queryText">The cosmos SQL query text.</param>
  /// <param name="continuationToken">The continuation token in the Azure Cosmos DB service.</param>

diff --git a/Microsoft.Azure.Cosmos/src/IDocumentClient.cs b/Microsoft.Azure.Cosmos/src/IDocumentClient.cs
@@ -3412,7 +3412,7 @@ IQueryable<dynamic> CreateDocumentQuery(
  IQueryable<dynamic> CreateStoredProcedureQuery(string collectionLink, string sqlExpression, FeedOptions feedOptions = null);
 
  /// <summary>
- /// Overloaded. This method creates a query for stored procedures under a collection in an Azure Cosmos DB database using a SQL statement using a SQL statement with parameterized values. It returns an IQueryable{dynamic}.
+ /// Overloaded. This method creates a query for stored procedures under a collection in an Azure Cosmos DB database using a SQL statement with parameterized values. It returns an IQueryable{dynamic}.
  /// For more information on preparing SQL statements with parameterized values, please see <see cref="SqlQuerySpec"/>.
  /// </summary>
  /// <param name="collectionLink">The link to the parent collection resource.</param>

diff --git a/Microsoft.Azure.Cosmos/src/Linq/DocumentClientQueryable.cs b/Microsoft.Azure.Cosmos/src/Linq/DocumentClientQueryable.cs
@@ -223,7 +223,7 @@ public IQueryable<dynamic> CreateStoredProcedureQuery(string collectionLink, str
  }
 
  /// <summary>
- /// Overloaded. This method creates a query for stored procedures under a collection in an Azure Cosmos DB database using a SQL statement using a SQL statement with parameterized values. It returns an IQueryable{dynamic}.
+ /// Overloaded. This method creates a query for stored procedures under a collection in an Azure Cosmos DB database using a SQL statement with parameterized values. It returns an IQueryable{dynamic}.
  /// For more information on preparing SQL statements with parameterized values, please see <see cref="SqlQuerySpec"/>.
  /// </summary>
  /// <param name="collectionLink">The link to the parent collection resource.</param>

diff --git a/Microsoft.Azure.Cosmos/src/Resource/Container/Container.cs b/Microsoft.Azure.Cosmos/src/Resource/Container/Container.cs
@@ -938,8 +938,7 @@ public abstract FeedIterator<T> GetItemQueryIterator<T>(
  QueryRequestOptions requestOptions = null);
 
  /// <summary>
- /// This method creates a query for items under a container in an Azure Cosmos database using a SQL statement with parameterized values. It returns a FeedIterator.
- /// For more information on preparing SQL statements with parameterized values, please see <see cref="QueryDefinition"/>.
+ /// This method creates a query for items under a container in an Azure Cosmos database using a SQL statement. It returns a FeedIterator.
  /// </summary>
  /// <param name="queryText">The Cosmos SQL query text.</param>
  /// <param name="continuationToken">(Optional) The continuation token in the Azure Cosmos DB service.</param>
@@ -1015,8 +1014,7 @@ public abstract FeedIterator GetItemQueryStreamIterator(
  QueryRequestOptions requestOptions = null);
 
  /// <summary>
- /// This method creates a query for items under a container in an Azure Cosmos database using a SQL statement with parameterized values. It returns a FeedIterator.
- /// For more information on preparing SQL statements with parameterized values, please see <see cref="QueryDefinition"/>.
+ /// This method creates a query for items under a container in an Azure Cosmos database using a SQL statement. It returns a FeedIterator.
  /// </summary>
  /// <param name="queryText">The Cosmos SQL query text.</param>
  /// <param name="continuationToken">(Optional) The continuation token in the Azure Cosmos DB service.</param>

diff --git a/Microsoft.Azure.Cosmos/src/Resource/Database/Database.cs b/Microsoft.Azure.Cosmos/src/Resource/Database/Database.cs
@@ -619,7 +619,7 @@ public abstract Task<UserResponse> UpsertUserAsync(string id,
  CancellationToken cancellationToken = default);
 
  /// <summary>
- /// This method creates a query for containers under an database using a SQL statement. It returns a FeedIterator.
+ /// This method creates a query for containers under an database using a SQL statement with parameterized values. It returns a FeedIterator.
  /// For more information on preparing SQL statements with parameterized values, please see <see cref="QueryDefinition"/> overload.
  /// </summary>
  /// <param name="queryDefinition">The Cosmos SQL query definition.</param>
@@ -659,7 +659,7 @@ public abstract FeedIterator<T> GetContainerQueryIterator<T>(
  QueryRequestOptions requestOptions = null);
 
  /// <summary>
- /// This method creates a query for containers under an database using a SQL statement. It returns a FeedIterator.
+ /// This method creates a query for containers under an database using a SQL statement with parameterized values. It returns a FeedIterator.
  /// For more information on preparing SQL statements with parameterized values, please see <see cref="QueryDefinition"/> overload.
  /// </summary>
  /// <param name="queryDefinition">The Cosmos SQL query definition.</param>
@@ -731,7 +731,6 @@ public abstract FeedIterator GetContainerQueryStreamIterator(
 
  /// <summary>
  /// This method creates a query for containers under an database using a SQL statement. It returns a FeedIterator.
- /// For more information on preparing SQL statements with parameterized values, please see <see cref="QueryDefinition"/> overload.
  /// </summary>
  /// <param name="queryText">The Cosmos SQL query text.</param>
  /// <param name="continuationToken">(Optional) The continuation token in the Azure Cosmos DB service.</param>
@@ -788,7 +787,6 @@ public abstract FeedIterator<T> GetContainerQueryIterator<T>(
 
  /// <summary>
  /// This method creates a query for containers under an database using a SQL statement. It returns a FeedIterator.
- /// For more information on preparing SQL statements with parameterized values, please see <see cref="QueryDefinition"/> overload.
  /// </summary>
  /// <param name="queryText">The Cosmos SQL query text.</param>
  /// <param name="continuationToken">The continuation token in the Azure Cosmos DB service.</param>
@@ -858,7 +856,6 @@ public abstract FeedIterator GetContainerQueryStreamIterator(
 
  /// <summary>
  /// This method creates a query for users under an database using a SQL statement. It returns a FeedIterator.
- /// For more information on preparing SQL statements with parameterized values, please see <see cref="QueryDefinition"/> overload.
  /// </summary>
  /// <param name="queryText">The Cosmos SQL query text.</param>
  /// <param name="continuationToken">(Optional) The continuation token in the Azure Cosmos DB service.</param>
@@ -908,7 +905,7 @@ public abstract FeedIterator<T> GetUserQueryIterator<T>(
  QueryRequestOptions requestOptions = null);
 
  /// <summary>
- /// This method creates a query for users under an database using a SQL statement. It returns a FeedIterator.
+ /// This method creates a query for users under an database using a SQL statement with parameterized values. It returns a FeedIterator.
  /// For more information on preparing SQL statements with parameterized values, please see <see cref="QueryDefinition"/> overload.
  /// </summary>
  /// <param name="queryDefinition">The Cosmos SQL query definition.</param>

diff --git a/Microsoft.Azure.Cosmos/src/Resource/Scripts/Scripts.cs b/Microsoft.Azure.Cosmos/src/Resource/Scripts/Scripts.cs
@@ -67,7 +67,7 @@ public abstract Task<StoredProcedureResponse> CreateStoredProcedureAsync(
  CancellationToken cancellationToken = default);
 
  /// <summary>
- /// This method creates a query for stored procedures under a container using a SQL statement. It returns a FeedIterator.
+ /// This method creates a query for stored procedures under a container using a SQL statement with parameterized values. It returns a FeedIterator.
  /// For more information on preparing SQL statements with parameterized values, please see <see cref="QueryDefinition"/> overload.
  /// </summary>
  /// <param name="queryDefinition">The cosmos SQL query definition.</param>
@@ -102,7 +102,7 @@ public abstract FeedIterator<T> GetStoredProcedureQueryIterator<T>(
  QueryRequestOptions requestOptions = null);
 
  /// <summary>
- /// This method creates a query for stored procedures under a container using a SQL statement. It returns a FeedIterator.
+ /// This method creates a query for stored procedures under a container using a SQL statement with parameterized values. It returns a FeedIterator.
  /// For more information on preparing SQL statements with parameterized values, please see <see cref="QueryDefinition"/> overload.
  /// </summary>
  /// <param name="queryDefinition">The cosmos SQL query definition.</param>
@@ -145,7 +145,6 @@ public abstract FeedIterator GetStoredProcedureQueryStreamIterator(
 
  /// <summary>
  /// This method creates a query for stored procedures under a container using a SQL statement. It returns a FeedIterator.
- /// For more information on preparing SQL statements with parameterized values, please see <see cref="QueryDefinition"/> overload.
  /// </summary>
  /// <param name="queryText">The cosmos SQL query text.</param>
  /// <param name="continuationToken">(Optional) The continuation token in the Azure Cosmos DB service.</param>
@@ -178,7 +177,6 @@ public abstract FeedIterator<T> GetStoredProcedureQueryIterator<T>(
 
  /// <summary>
  /// This method creates a query for stored procedures under a container using a SQL statement. It returns a FeedIterator.
- /// For more information on preparing SQL statements with parameterized values, please see <see cref="QueryDefinition"/> overload.
  /// </summary>
  /// <param name="queryText">The cosmos SQL query text.</param>
  /// <param name="continuationToken">(Optional) The continuation token in the Azure Cosmos DB service.</param>
@@ -531,7 +529,7 @@ public abstract Task<TriggerResponse> CreateTriggerAsync(
  CancellationToken cancellationToken = default);
 
  /// <summary>
- /// This method creates a query for triggers under a container using a SQL statement. It returns a FeedIterator.
+ /// This method creates a query for triggers under a container using a SQL statement with parameterized values. It returns a FeedIterator.
  /// For more information on preparing SQL statements with parameterized values, please see <see cref="QueryDefinition"/> overload.
  /// </summary>
  /// <param name="queryDefinition">The cosmos SQL query definition.</param>
@@ -565,7 +563,7 @@ public abstract FeedIterator<T> GetTriggerQueryIterator<T>(
  QueryRequestOptions requestOptions = null);
 
  /// <summary>
- /// This method creates a query for triggers under a container using a SQL statement. It returns a FeedIterator.
+ /// This method creates a query for triggers under a container using a SQL statement with parameterized values. It returns a FeedIterator.
  /// For more information on preparing SQL statements with parameterized values, please see <see cref="QueryDefinition"/> overload.
  /// </summary>
  /// <param name="queryDefinition">The cosmos SQL query definition.</param>
@@ -607,7 +605,6 @@ public abstract FeedIterator GetTriggerQueryStreamIterator(
 
  /// <summary>
  /// This method creates a query for triggers under a container using a SQL statement. It returns a FeedIterator.
- /// For more information on preparing SQL statements with parameterized values, please see <see cref="QueryDefinition"/> overload.
  /// </summary>
  /// <param name="queryText">The cosmos SQL query text.</param>
  /// <param name="continuationToken">(Optional) The continuation token in the Azure Cosmos DB service.</param>
@@ -640,7 +637,6 @@ public abstract FeedIterator<T> GetTriggerQueryIterator<T>(
 
  /// <summary>
  /// This method creates a query for triggers under a container using a SQL statement. It returns a FeedIterator.
- /// For more information on preparing SQL statements with parameterized values, please see <see cref="QueryDefinition"/> overload.
  /// </summary>
  /// <param name="queryText">The cosmos SQL query text.</param>
  /// <param name="continuationToken">(Optional) The continuation token in the Azure Cosmos DB service.</param>
@@ -797,7 +793,7 @@ public abstract Task<UserDefinedFunctionResponse> CreateUserDefinedFunctionAsync
  CancellationToken cancellationToken = default);
 
  /// <summary>
- /// This method creates a query for user defined functions under a container using a SQL statement. It returns a FeedIterator.
+ /// This method creates a query for user defined functions under a container using a SQL statement with parameterized values. It returns a FeedIterator.
  /// For more information on preparing SQL statements with parameterized values, please see <see cref="QueryDefinition"/> overload.
  /// </summary>
  /// <param name="queryDefinition">The cosmos SQL query definition.</param>
@@ -831,7 +827,7 @@ public abstract FeedIterator<T> GetUserDefinedFunctionQueryIterator<T>(
  QueryRequestOptions requestOptions = null);
 
  /// <summary>
- /// This method creates a query for user defined functions under a container using a SQL statement. It returns a FeedIterator.
+ /// This method creates a query for user defined functions under a container using a SQL statement with parameterized values. It returns a FeedIterator.
  /// For more information on preparing SQL statements with parameterized values, please see <see cref="QueryDefinition"/> overload.
  /// </summary>
  /// <param name="queryDefinition">The cosmos SQL query definition.</param>
@@ -873,7 +869,6 @@ public abstract FeedIterator GetUserDefinedFunctionQueryStreamIterator(
 
  /// <summary>
  /// This method creates a query for user defined functions under a container using a SQL statement. It returns a FeedIterator.
- /// For more information on preparing SQL statements with parameterized values, please see <see cref="QueryDefinition"/> overload.
  /// </summary>
  /// <param name="queryText">The cosmos SQL query text.</param>
  /// <param name="continuationToken">(Optional) The continuation token in the Azure Cosmos DB service.</param>
@@ -906,7 +901,6 @@ public abstract FeedIterator<T> GetUserDefinedFunctionQueryIterator<T>(
 
  /// <summary>
  /// This method creates a query for user defined functions under a container using a SQL statement. It returns a FeedIterator.
- /// For more information on preparing SQL statements with parameterized values, please see <see cref="QueryDefinition"/> overload.
  /// </summary>
  /// <param name="queryText">The cosmos SQL query text.</param>
  /// <param name="continuationToken">(Optional) The continuation token in the Azure Cosmos DB service.</param>

diff --git a/Microsoft.Azure.Cosmos/src/Resource/User/User.cs b/Microsoft.Azure.Cosmos/src/Resource/User/User.cs
@@ -153,7 +153,6 @@ public abstract Task<PermissionResponse> UpsertPermissionAsync(
 
  /// <summary>
  /// This method creates a query for permission under a user using a SQL statement. It returns a FeedIterator.
- /// For more information on preparing SQL statements with parameterized values, please see <see cref="QueryDefinition"/> overload.
  /// </summary>
  /// <param name="queryText">The cosmos SQL query text.</param>
  /// <param name="continuationToken">(Optional) The continuation token in the Azure Cosmos DB service.</param>
@@ -203,7 +202,7 @@ public abstract FeedIterator<T> GetPermissionQueryIterator<T>(
  QueryRequestOptions requestOptions = null);
 
  /// <summary>
- /// This method creates a query for permissions under a database using a SQL statement. It returns a FeedIterator.
+ /// This method creates a query for permissions under a database using a SQL statement with parameterized values. It returns a FeedIterator.
  /// For more information on preparing SQL statements with parameterized values, please see <see cref="QueryDefinition"/> overload.
  /// </summary>
  /// <remarks>