From 4f22e0a05cc00b59baeb13de730e40c48af9f4ee Mon Sep 17 00:00:00 2001 From: Julian Nguyen <109386615+juliannguyen4@users.noreply.github.com> Date: Wed, 22 Jan 2025 10:05:58 -0800 Subject: [PATCH] [CLIENT-3272] Docs: rename read/write operations to commands (#714) --- aerospike_helpers/batch/records.py | 4 ++-- doc/aerospike.rst | 2 +- doc/client.rst | 4 ++-- doc/geojson.rst | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/aerospike_helpers/batch/records.py b/aerospike_helpers/batch/records.py index a45ec9889..15359035b 100644 --- a/aerospike_helpers/batch/records.py +++ b/aerospike_helpers/batch/records.py @@ -58,7 +58,7 @@ def __init__(self, key: tuple) -> None: class Write(BatchRecord): - """ Write is used for executing Batch write operations with batch_write and retrieving batch write results. + """ 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. @@ -109,7 +109,7 @@ def __init__( class Read(BatchRecord): - """ Read is used for executing Batch read operations with batch_write and retrieving results. + """ Read is used for executing Batch read commands with batch_write and retrieving results. Attributes: key (:obj:`tuple`): The aerospike key to operate on. diff --git a/doc/aerospike.rst b/doc/aerospike.rst index 7c45dc689..6fd71f1a4 100644 --- a/doc/aerospike.rst +++ b/doc/aerospike.rst @@ -51,7 +51,7 @@ Client # Configure the client to first connect to a cluster node at 127.0.0.1 # The client will learn about the other nodes in the cluster from the seed node. - # Also sets a top level policy for read operations + # Also sets a top level policy for read commands config = { 'hosts': [ ('127.0.0.1', 3000) ], 'policies': {'read': {'total_timeout': 1000}}, diff --git a/doc/client.rst b/doc/client.rst index ba0a7cfd3..192054edf 100755 --- a/doc/client.rst +++ b/doc/client.rst @@ -364,7 +364,7 @@ Batch Operations .. method:: batch_operate(keys: list, ops: list, [policy_batch: dict], [policy_batch_write: dict], [ttl: int]) -> BatchRecords - Perform the same read/write commands on multiple keys. + Perform the same read/write operations on multiple keys. .. note:: Prior to Python client 14.0.0, using the :meth:`~batch_operate()` method with only read operations caused an error. This bug was fixed in version 14.0.0. @@ -1498,7 +1498,7 @@ Record Tuple .. object:: record - The record tuple which is returned by various read operations. It has the structure: + The record tuple which is returned by various read commands. It has the structure: ``(key, meta, bins)`` diff --git a/doc/geojson.rst b/doc/geojson.rst index 7b63c2fc1..5f5535985 100755 --- a/doc/geojson.rst +++ b/doc/geojson.rst @@ -23,7 +23,7 @@ It also enables queries for regions that contain a given point using: On the client side, wrapping geospatial data in an instance of the :class:`aerospike.GeoJSON` class enables serialization of the data into the -correct type during a write operation, such as :meth:`~aerospike.Client.put`. +correct type during a write operation, such as in :meth:`~aerospike.Client.put`. When reading a record from the server, bins with geospatial data will be deserialized into a :class:`~aerospike.GeoJSON` instance.