Skip to content

Commit 33ed8ea

Browse files
authored
[Tables] Fixing batch error docs (Azure#48921)
The focus of these changes is to fix a formatting error with the batch operations and add the error scenario for an empty batch passed to the method.
1 parent 27a7555 commit 33ed8ea

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

sdk/tables/Azure.Data.Tables/src/TableClient.cs

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1543,8 +1543,10 @@ public virtual Response SetAccessPolicy(IEnumerable<TableSignedIdentifier> table
15431543
/// <returns><see cref="Response{T}"/> containing a <see cref="IReadOnlyList{T}"/> of <see cref="Response"/>.
15441544
/// Each sub-response in the collection corresponds to the <see cref="TableTransactionAction"/> provided to the <paramref name="transactionActions"/> parameter at the same index position.
15451545
/// Each response can be inspected for details for its corresponding table operation, such as the <see cref="Response.Headers"/> property containing the <see cref="ResponseHeaders.ETag"/></returns>
1546-
/// <exception cref="RequestFailedException"/> if the batch transaction fails./>
1547-
/// <exception cref="InvalidOperationException"/> if the batch has been previously submitted.
1546+
/// <exception cref="RequestFailedException"> Thrown when the batch transaction operation fails.</exception>
1547+
/// <exception cref="ArgumentNullException"> Thrown when <paramref name="transactionActions"/> is <c>null</c>.</exception>
1548+
/// <exception cref="InvalidOperationException">Thrown if <paramref name="transactionActions"/> contains no items.</exception>
1549+
/// <exception cref="InvalidOperationException"> Thrown if the batch has been previously submitted.</exception>
15481550
public virtual async Task<Response<IReadOnlyList<Response>>> SubmitTransactionAsync(
15491551
IEnumerable<TableTransactionAction> transactionActions,
15501552
CancellationToken cancellationToken = default) =>
@@ -1560,8 +1562,10 @@ await SubmitTransactionInternalAsync(transactionActions, _batchGuid ?? Guid.NewG
15601562
/// <returns><see cref="Response{T}"/> containing a <see cref="IReadOnlyList{T}"/> of <see cref="Response"/>.
15611563
/// Each sub-response in the collection corresponds to the <see cref="TableTransactionAction"/> provided to the <paramref name="transactionActions"/> parameter at the same index position.
15621564
/// Each response can be inspected for details for its corresponding table operation, such as the <see cref="Response.Headers"/> property containing the <see cref="ResponseHeaders.ETag"/></returns>
1563-
/// <exception cref="RequestFailedException"/> if the batch transaction fails./>
1564-
/// <exception cref="InvalidOperationException"/> if the batch has been previously submitted.
1565+
/// <exception cref="RequestFailedException"> Thrown when the batch transaction operation fails.</exception>
1566+
/// <exception cref="ArgumentNullException"> Thrown when <paramref name="transactionActions"/> is <c>null</c>.</exception>
1567+
/// <exception cref="InvalidOperationException">Thrown when <paramref name="transactionActions"/> contains no items.</exception>
1568+
/// <exception cref="InvalidOperationException"> Thrown if the batch has been previously submitted.</exception>
15651569
public virtual Response<IReadOnlyList<Response>> SubmitTransaction(
15661570
IEnumerable<TableTransactionAction> transactionActions,
15671571
CancellationToken cancellationToken = default) =>

0 commit comments

Comments
 (0)