From d7b9546696e1e5b9d729b84bc6d0f60245046061 Mon Sep 17 00:00:00 2001 From: Pramod Valavala <43602528+PramodValavala-MSFT@users.noreply.github.com> Date: Fri, 11 Feb 2022 00:08:05 +0530 Subject: [PATCH] Documentation: Fixes method descriptions with sql query text vs definition (#3024) * Fix method descriptions with sql query text vs definition * Fix descriptions in a couple more places --- Microsoft.Azure.Cosmos/src/CosmosClient.cs | 2 -- Microsoft.Azure.Cosmos/src/IDocumentClient.cs | 2 +- .../src/Linq/DocumentClientQueryable.cs | 2 +- .../src/Resource/Container/Container.cs | 6 ++---- .../src/Resource/Database/Database.cs | 9 +++------ .../src/Resource/Scripts/Scripts.cs | 18 ++++++------------ .../src/Resource/User/User.cs | 3 +-- 7 files changed, 14 insertions(+), 28 deletions(-) diff --git a/Microsoft.Azure.Cosmos/src/CosmosClient.cs b/Microsoft.Azure.Cosmos/src/CosmosClient.cs index 473a2ab4d8..c63a1e81d5 100644 --- a/Microsoft.Azure.Cosmos/src/CosmosClient.cs +++ b/Microsoft.Azure.Cosmos/src/CosmosClient.cs @@ -889,7 +889,6 @@ public virtual FeedIterator GetDatabaseQueryStreamIterator( /// /// 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 overload. /// /// The cosmos SQL query text. /// The continuation token in the Azure Cosmos DB service. @@ -942,7 +941,6 @@ public virtual FeedIterator GetDatabaseQueryIterator( /// /// 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 overload. /// /// The cosmos SQL query text. /// The continuation token in the Azure Cosmos DB service. diff --git a/Microsoft.Azure.Cosmos/src/IDocumentClient.cs b/Microsoft.Azure.Cosmos/src/IDocumentClient.cs index bbe2ed3fb0..86e222ca97 100644 --- a/Microsoft.Azure.Cosmos/src/IDocumentClient.cs +++ b/Microsoft.Azure.Cosmos/src/IDocumentClient.cs @@ -3412,7 +3412,7 @@ IQueryable CreateDocumentQuery( IQueryable CreateStoredProcedureQuery(string collectionLink, string sqlExpression, FeedOptions feedOptions = null); /// - /// 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 . /// /// The link to the parent collection resource. diff --git a/Microsoft.Azure.Cosmos/src/Linq/DocumentClientQueryable.cs b/Microsoft.Azure.Cosmos/src/Linq/DocumentClientQueryable.cs index 479f524c4d..013ee98d10 100644 --- a/Microsoft.Azure.Cosmos/src/Linq/DocumentClientQueryable.cs +++ b/Microsoft.Azure.Cosmos/src/Linq/DocumentClientQueryable.cs @@ -223,7 +223,7 @@ public IQueryable CreateStoredProcedureQuery(string collectionLink, str } /// - /// 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 . /// /// The link to the parent collection resource. diff --git a/Microsoft.Azure.Cosmos/src/Resource/Container/Container.cs b/Microsoft.Azure.Cosmos/src/Resource/Container/Container.cs index 9186a153ea..0017bfafb6 100644 --- 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 GetItemQueryIterator( QueryRequestOptions requestOptions = null); /// - /// 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 . + /// This method creates a query for items under a container in an Azure Cosmos database using a SQL statement. It returns a FeedIterator. /// /// The Cosmos SQL query text. /// (Optional) The continuation token in the Azure Cosmos DB service. @@ -1015,8 +1014,7 @@ public abstract FeedIterator GetItemQueryStreamIterator( QueryRequestOptions requestOptions = null); /// - /// 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 . + /// This method creates a query for items under a container in an Azure Cosmos database using a SQL statement. It returns a FeedIterator. /// /// The Cosmos SQL query text. /// (Optional) The continuation token in the Azure Cosmos DB service. diff --git a/Microsoft.Azure.Cosmos/src/Resource/Database/Database.cs b/Microsoft.Azure.Cosmos/src/Resource/Database/Database.cs index de6704000e..8c99911389 100644 --- 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 UpsertUserAsync(string id, CancellationToken cancellationToken = default); /// - /// 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 overload. /// /// The Cosmos SQL query definition. @@ -659,7 +659,7 @@ public abstract FeedIterator GetContainerQueryIterator( QueryRequestOptions requestOptions = null); /// - /// 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 overload. /// /// The Cosmos SQL query definition. @@ -731,7 +731,6 @@ public abstract FeedIterator GetContainerQueryStreamIterator( /// /// 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 overload. /// /// The Cosmos SQL query text. /// (Optional) The continuation token in the Azure Cosmos DB service. @@ -788,7 +787,6 @@ public abstract FeedIterator GetContainerQueryIterator( /// /// 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 overload. /// /// The Cosmos SQL query text. /// The continuation token in the Azure Cosmos DB service. @@ -858,7 +856,6 @@ public abstract FeedIterator GetContainerQueryStreamIterator( /// /// 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 overload. /// /// The Cosmos SQL query text. /// (Optional) The continuation token in the Azure Cosmos DB service. @@ -908,7 +905,7 @@ public abstract FeedIterator GetUserQueryIterator( QueryRequestOptions requestOptions = null); /// - /// 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 overload. /// /// The Cosmos SQL query definition. diff --git a/Microsoft.Azure.Cosmos/src/Resource/Scripts/Scripts.cs b/Microsoft.Azure.Cosmos/src/Resource/Scripts/Scripts.cs index 4e1611999c..6237329b26 100644 --- 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 CreateStoredProcedureAsync( CancellationToken cancellationToken = default); /// - /// 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 overload. /// /// The cosmos SQL query definition. @@ -102,7 +102,7 @@ public abstract FeedIterator GetStoredProcedureQueryIterator( QueryRequestOptions requestOptions = null); /// - /// 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 overload. /// /// The cosmos SQL query definition. @@ -145,7 +145,6 @@ public abstract FeedIterator GetStoredProcedureQueryStreamIterator( /// /// 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 overload. /// /// The cosmos SQL query text. /// (Optional) The continuation token in the Azure Cosmos DB service. @@ -178,7 +177,6 @@ public abstract FeedIterator GetStoredProcedureQueryIterator( /// /// 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 overload. /// /// The cosmos SQL query text. /// (Optional) The continuation token in the Azure Cosmos DB service. @@ -531,7 +529,7 @@ public abstract Task CreateTriggerAsync( CancellationToken cancellationToken = default); /// - /// 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 overload. /// /// The cosmos SQL query definition. @@ -565,7 +563,7 @@ public abstract FeedIterator GetTriggerQueryIterator( QueryRequestOptions requestOptions = null); /// - /// 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 overload. /// /// The cosmos SQL query definition. @@ -607,7 +605,6 @@ public abstract FeedIterator GetTriggerQueryStreamIterator( /// /// 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 overload. /// /// The cosmos SQL query text. /// (Optional) The continuation token in the Azure Cosmos DB service. @@ -640,7 +637,6 @@ public abstract FeedIterator GetTriggerQueryIterator( /// /// 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 overload. /// /// The cosmos SQL query text. /// (Optional) The continuation token in the Azure Cosmos DB service. @@ -797,7 +793,7 @@ public abstract Task CreateUserDefinedFunctionAsync CancellationToken cancellationToken = default); /// - /// 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 overload. /// /// The cosmos SQL query definition. @@ -831,7 +827,7 @@ public abstract FeedIterator GetUserDefinedFunctionQueryIterator( QueryRequestOptions requestOptions = null); /// - /// 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 overload. /// /// The cosmos SQL query definition. @@ -873,7 +869,6 @@ public abstract FeedIterator GetUserDefinedFunctionQueryStreamIterator( /// /// 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 overload. /// /// The cosmos SQL query text. /// (Optional) The continuation token in the Azure Cosmos DB service. @@ -906,7 +901,6 @@ public abstract FeedIterator GetUserDefinedFunctionQueryIterator( /// /// 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 overload. /// /// The cosmos SQL query text. /// (Optional) The continuation token in the Azure Cosmos DB service. diff --git a/Microsoft.Azure.Cosmos/src/Resource/User/User.cs b/Microsoft.Azure.Cosmos/src/Resource/User/User.cs index 1c8e2f8fc8..4f00856311 100644 --- 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 UpsertPermissionAsync( /// /// 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 overload. /// /// The cosmos SQL query text. /// (Optional) The continuation token in the Azure Cosmos DB service. @@ -203,7 +202,7 @@ public abstract FeedIterator GetPermissionQueryIterator( QueryRequestOptions requestOptions = null); /// - /// 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 overload. /// ///