[CLIENT-3272] Docs: rename "batch operations" to "batched commands" (#…

…714)

aerospike_helpers/batch/records.py

@@ -44,7 +44,7 @@ class BatchRecord:
         Attributes:
             key (:obj:`tuple`): The aerospike key to operate on.
             record (:ref:`aerospike_record_tuple`): The record corresponding to the requested key.
-            result (int): The status code of the operation.
+            result (int): The status code of the command.
             in_doubt (bool): Is it possible that the write transaction completed even though an error was generated. \
             This may be the case when a client error occurs (like timeout) after the command was sent \
             to the server.
@@ -61,15 +61,15 @@ class Write(BatchRecord):
     """ Write is used for executing Batch write commands with batch_write and retrieving batch write results.
 
         Attributes:
-            key (:obj:`tuple`): The aerospike key to operate on.
+            key (:obj:`tuple`): The aerospike key to send the command to.
             record (:obj:`tuple`): The record corresponding to the requested key.
-            result (int): The status code of the operation.
+            result (int): The status code of the command.
             in_doubt (bool): Is it possible that the write transaction completed even though an error was generated. \
             This may be the case when a client error occurs (like timeout) after the command was sent \
             to the server.
             ops (:ref:`aerospike_operation_helpers.operations`): A list of aerospike operation dictionaries to perform
                 on the record at key.
-            meta (dict): the metadata to set for the operations in this BatchRecord
+            meta (dict): the metadata to set for this command
             policy (:ref:`aerospike_batch_write_policies`, optional): An optional dictionary of batch write policy
                 flags.
     """
@@ -112,15 +112,15 @@ class Read(BatchRecord):
     """ Read is used for executing Batch read commands with batch_write and retrieving results.
 
         Attributes:
-            key (:obj:`tuple`): The aerospike key to operate on.
+            key (:obj:`tuple`): The aerospike key to send the command to.
             record (:obj:`tuple`): The record corresponding to the requested key.
-            result (int): The status code of the operation.
+            result (int): The status code of the command.
             in_doubt (bool): Is it possible that the write transaction completed even though an error was generated. \
             This may be the case when a client error occurs (like timeout) after the command was sent \
             to the server.
             ops (:ref:`aerospike_operation_helpers.operations`): list of aerospike operation dictionaries to perform on
                 the record at key.
-            meta (dict): the metadata to set for the operations in this BatchRecord
+            meta (dict): the metadata to set for this command
             read_all_bins (bool, optional): An optional bool, if True, read all bins in the record.
             policy (:ref:`aerospike_batch_read_policies`, optional): An optional dictionary of batch read policy flags.
     """
@@ -165,7 +165,7 @@ def __init__(
 
 
 class Apply(BatchRecord):
-    """ BatchApply is used for executing Batch UDF (user defined function) apply operations with batch_write and
+    """ BatchApply is used for executing Batch UDF (user defined function) apply commands with batch_write and
         retrieving results.
 
         Attributes:
@@ -174,8 +174,8 @@ class Apply(BatchRecord):
             function (str): Name of the UDF to invoke.
             args (:obj:`list`): List of arguments to pass to the UDF.
             record (:ref:`aerospike_record_tuple`): The record corresponding to the requested key.
-            result (int): The status code of the operation.
-            in_doubt (bool): Is it possible that the write transaction completed even though an error was generated. \
+            result (int): The status code of the command.
+            in_doubt (bool): Is it possible that the write command completed even though an error was generated. \
             This may be the case when a client error occurs (like timeout) after the command was sent \
             to the server.
             policy (:ref:`aerospike_batch_apply_policies`, optional): An optional dictionary of batch apply policy
@@ -219,12 +219,12 @@ def __init__(
 
 
 class Remove(BatchRecord):
-    """ Remove is used for executing Batch remove operations with batch_write and retrieving results.
+    """ Remove is used for executing Batch remove commands with batch_write and retrieving results.
 
         Attributes:
             key (:obj:`tuple`): The aerospike key to operate on.
             record (:ref:`aerospike_record_tuple`): The record corresponding to the requested key.
-            result (int): The status code of the operation.
+            result (int): The status code of the command.
             in_doubt (bool): Is it possible that the write transaction completed even though an error was generated. \
             This may be the case when a client error occurs (like timeout) after the command was sent \
             to the server.
@@ -261,7 +261,7 @@ class BatchRecords:
 
         Attributes:
             batch_records (list): A list of BatchRecord subtype objects used to \
-            define batch operations and hold results. BatchRecord Types can be Remove, Write, \
+            define batched commands and hold results. BatchRecord Types can be Remove, Write, \
             Read, and Apply.
             result (int): The status code of the last batch call that used this BatchRecords.
                 ``0`` if all batch subtransactions succeeded (or if the only failures were \

doc/aerospike_helpers.expressions.rst

@@ -37,8 +37,8 @@ Example:
   :code: python
 
 Currently, Aerospike expressions are supported for:
-- Record operations
-- Batch operations
+- Record commands
+- Batched commands
 - Transactions
 - UDF apply methods (apply, scan apply, and query apply)
 - Query invoke methods (foreach, results, execute background)

doc/client.rst

@@ -215,9 +215,9 @@ Record Operations
             :code: python
 
     .. index::
-        single: Batch Operations
+        single: Batched Commands
 
-Batch Operations
+Batched Commands
 ----------------
 
 .. class:: Client

doc/index.rst

@@ -46,7 +46,7 @@ Layout
     * :mod:`aerospike_helpers`
         * Bin operations (list, map, bitwise, etc.)
         * Aerospike expressions
-        * Batch operations
+        * Batch commands
         * Complex data type context
 
 The :class:`aerospike` module contains these classes: