[Cosmos] archboard review item - update batch error description (#34473)

* update batch error description

* Revert "update batch error description"

This reverts commit 9fbe949.

* linked sample, updated ivar

* Update exceptions.py

* Update exceptions.py

* Update exceptions.py

* Update exceptions.py

Author: simorenoh

sdk/cosmos/azure-cosmos/azure/cosmos/exceptions.py

@@ -66,8 +66,27 @@ class CosmosAccessConditionFailedError(CosmosHttpResponseError):
 
 
 class CosmosBatchOperationError(HttpResponseError):
-    """A transactional batch request to the Azure Cosmos database service has failed."""
-
+    """A transactional batch request to the Azure Cosmos database service has failed.
+
+    :ivar int error_index: Index of operation within the batch that caused the error.
+    :ivar headers: Error headers.
+    :vartype headers: dict[str, Any]
+    :ivar status_code: HTTP response code.
+    :vartype status_code: int
+    :ivar message: Error message.
+    :vartype message: str
+    :ivar operation_responses: List of failed operations' responses.
+    :vartype operation_responses: List[dict[str, Any]]
+    .. admonition:: Example:
+
+        .. literalinclude:: ../samples/document_management.py
+            :start-after: [START handle_batch_error]
+            :end-before: [END handle_batch_error]
+            :language: python
+            :dedent: 0
+            :caption: Handle a CosmosBatchOperationError:
+            :name: handle_batch_error
+    """
     def __init__(
             self,
             error_index=None,
@@ -76,13 +95,6 @@ def __init__(
             message=None,
             operation_responses=None,
             **kwargs):
-        """
-        :param int error_index: Index of operation within the batch that caused the error.
-        :param dict[str, Any] headers: Error headers.
-        :param int status_code: HTTP response code.
-        :param str message: Error message.
-        :param list operation_responses: List of failed operations' responses.
-        """
         self.error_index = error_index
         self.headers = headers
         self.sub_status = None

sdk/cosmos/azure-cosmos/samples/document_management.py

@@ -243,6 +243,7 @@ def execute_item_batch(database):
 
     # For error handling, you should use try/ except with CosmosBatchOperationError and use the information in the
     # error returned for your application debugging, making it easy to pinpoint the failing operation
+    # [START handle_batch_error]
     batch_operations = [create_item_operation, create_item_operation]
     try:
         container.execute_item_batch(batch_operations, partition_key="Account1")
@@ -251,6 +252,7 @@ def execute_item_batch(database):
         error_operation_response = e.operation_responses[error_operation_index]
         error_operation = batch_operations[error_operation_index]
         print("\nError operation: {}, error operation response: {}\n".format(error_operation, error_operation_response))
+    # [END handle_batch_error]
 
 
 def delete_item(container, doc_id):

sdk/cosmos/azure-cosmos/samples/document_management_async.py

@@ -262,6 +262,7 @@ async def execute_item_batch(database):
 
     # For error handling, you should use try/ except with CosmosBatchOperationError and use the information in the
     # error returned for your application debugging, making it easy to pinpoint the failing operation
+    # [START handle_batch_error]
     batch_operations = [create_item_operation, create_item_operation]
     try:
         await container.execute_item_batch(batch_operations, partition_key="Account1")
@@ -270,6 +271,7 @@ async def execute_item_batch(database):
         error_operation_response = e.operation_responses[error_operation_index]
         error_operation = batch_operations[error_operation_index]
         print("\nError operation: {}, error operation response: {}\n".format(error_operation, error_operation_response))
+    # [END handle_batch_error]
 
 
 async def delete_item(container, doc_id):