From 9e9bc2ac33967b0995012de2be565e1b2115f597 Mon Sep 17 00:00:00 2001 From: Julian Nguyen <109386615+juliannguyen4@users.noreply.github.com> Date: Tue, 7 Jul 2026 14:48:05 -0700 Subject: [PATCH] Unify key policy option documentation. TODO - need to determine which policies' key options are affected by the new union rule --- doc/client.rst | 35 +++++++---------------------------- doc/key.rst | 5 +++++ 2 files changed, 12 insertions(+), 28 deletions(-) create mode 100644 doc/key.rst diff --git a/doc/client.rst b/doc/client.rst index 5caecbdc22..7ff3b14caa 100755 --- a/doc/client.rst +++ b/doc/client.rst @@ -1772,10 +1772,7 @@ Write Policies .. hlist:: :columns: 1 - * **key** - | One of the :ref:`POLICY_KEY` values such as :data:`aerospike.POLICY_KEY_DIGEST` - | - | Default: :data:`aerospike.POLICY_KEY_DIGEST` + * .. include:: ./key.rst * **exists** | One of the :ref:`POLICY_EXISTS` values such as :data:`aerospike.POLICY_EXISTS_CREATE` | @@ -1887,10 +1884,7 @@ Operate Policies .. hlist:: :columns: 1 - * **key** - | One of the :ref:`POLICY_KEY` values such as :data:`aerospike.POLICY_KEY_DIGEST` - | - | Default: :data:`aerospike.POLICY_KEY_DIGEST` + * .. include:: ./key.rst * **gen** | One of the :ref:`POLICY_GEN` values such as :data:`aerospike.POLICY_GEN_IGNORE` | @@ -1974,10 +1968,7 @@ Apply Policies .. hlist:: :columns: 1 - * **key** - | One of the :ref:`POLICY_KEY` values such as :data:`aerospike.POLICY_KEY_DIGEST` - | - | Default: :data:`aerospike.POLICY_KEY_DIGEST` + * .. include:: ./key.rst * **replica** | One of the :ref:`POLICY_REPLICA` values such as :data:`aerospike.POLICY_REPLICA_MASTER` | @@ -2011,10 +2002,7 @@ Remove Policies .. hlist:: :columns: 1 - * **key** - | One of the :ref:`POLICY_KEY` values such as :data:`aerospike.POLICY_KEY_DIGEST` - | - | Default: :data:`aerospike.POLICY_KEY_DIGEST` + * .. include:: ./key.rst * **commit_level** | One of the :ref:`POLICY_COMMIT_LEVEL` values such as :data:`aerospike.POLICY_COMMIT_LEVEL_ALL` | @@ -2140,10 +2128,7 @@ Batch Write Policies .. hlist:: :columns: 1 - * **key** - | One of the :ref:`POLICY_KEY` values such as :data:`aerospike.POLICY_KEY_DIGEST` - | - | Default: :data:`aerospike.POLICY_KEY_DIGEST` + * .. include:: ./key.rst * **commit_level** | One of the :ref:`POLICY_COMMIT_LEVEL` values such as :data:`aerospike.POLICY_COMMIT_LEVEL_ALL` | @@ -2195,10 +2180,7 @@ Batch Apply Policies .. hlist:: :columns: 1 - * **key** - | One of the :ref:`POLICY_KEY` values such as :data:`aerospike.POLICY_KEY_DIGEST` - | - | Default: :data:`aerospike.POLICY_KEY_DIGEST` + * .. include:: ./key.rst * **commit_level** | One of the :ref:`POLICY_COMMIT_LEVEL` values such as :data:`aerospike.POLICY_COMMIT_LEVEL_ALL` | @@ -2234,10 +2216,7 @@ Batch Remove Policies .. hlist:: :columns: 1 - * **key** - | One of the :ref:`POLICY_KEY` values such as :data:`aerospike.POLICY_KEY_DIGEST` - | - | Default: :data:`aerospike.POLICY_KEY_DIGEST` + * .. include:: ./key.rst * **commit_level** | One of the :ref:`POLICY_COMMIT_LEVEL` values such as :data:`aerospike.POLICY_COMMIT_LEVEL_ALL` | diff --git a/doc/key.rst b/doc/key.rst new file mode 100644 index 0000000000..ade70bd407 --- /dev/null +++ b/doc/key.rst @@ -0,0 +1,5 @@ +**key** + + One of the :ref:`POLICY_KEY` values such as :data:`aerospike.POLICY_KEY_DIGEST` + + Default: :data:`aerospike.POLICY_KEY_DIGEST`