diff --git a/aerospike_helpers/operations/bitwise_operations.py b/aerospike_helpers/operations/bitwise_operations.py index f0677bbe28..32d283a273 100644 --- a/aerospike_helpers/operations/bitwise_operations.py +++ b/aerospike_helpers/operations/bitwise_operations.py @@ -167,6 +167,8 @@ def bit_resize(bin_name: str, byte_size, policy=None, resize_flags: int = 0): bin_name (str): The name of the bin containing the map. byte_size (int): The new size of the bytes. policy (dict): The :ref:`bit_policy ` dictionary. default: None. + # TODO: this is the only method referencing these flags, but should document explicitly that + # the flags can be bitwise OR'd together. resize_flags (int): :ref:`aerospike_bitwise_resize_flag` modifying the resize behavior (default ``aerospike.BIT_RESIZE_DEFAULT``), such as ``aerospike.BIT_RESIZE_GROW_ONLY | aerospike.BIT_RESIZE_FROM_FRONT``. diff --git a/aerospike_helpers/operations/map_operations.py b/aerospike_helpers/operations/map_operations.py index 32f62df5d5..c17a35c896 100755 --- a/aerospike_helpers/operations/map_operations.py +++ b/aerospike_helpers/operations/map_operations.py @@ -968,7 +968,8 @@ def map_remove_by_value_rank_range_relative( Note: This operation requires server version 4.3.0 or greater. - Examples for a key ordered map ``{0: 6, 6: 12, 10: 18, 15: 24}`` and return type of ``aerospike.MAP_RETURN_KEY``: + Examples for a key ordered map ``{0: 6, 6: 12, 10: 18, 15: 24}`` and return type of + :py:data:`aerospike.MAP_RETURN_KEY`: :: @@ -1041,7 +1042,7 @@ def map_get_by_value_rank_range_relative( Note: This operation requires server version 4.3.0 or greater. - Examples for map ``{0: 6, 10: 18, 6: 12, 15: 24}`` and return type of ``aerospike.MAP_RETURN_KEY``. + Examples for map ``{0: 6, 10: 18, 6: 12, 15: 24}`` and return type of :py:data:`aerospike.MAP_RETURN_KEY`. See :meth:`map_remove_by_value_rank_range_relative` for in-depth explanation. :: @@ -1101,7 +1102,7 @@ def map_remove_by_key_index_range_relative( should be considered an internal detail, and subject to change. Examples for a key ordered map ``{0: 6, 6: 12, 10: 18, 15: 24}`` - and return type of ``aerospike.MAP_RETURN_KEY`` + and return type of :py:data:`aerospike.MAP_RETURN_KEY` :: @@ -1175,7 +1176,7 @@ def map_get_by_key_index_range_relative( This operation requires server version 4.3.0 or greater. Examples for a key ordered map ``{0: 6, 6: 12, 10: 18, 15: 24}`` - and return type of ``aerospike.MAP_RETURN_KEY``. + and return type of :py:data:`aerospike.MAP_RETURN_KEY`. See :meth:`map_remove_by_key_index_range_relative` for in-depth explanation. :: diff --git a/doc/aerospike.rst b/doc/aerospike.rst index 3e4571a7c4..111d1a3083 100644 --- a/doc/aerospike.rst +++ b/doc/aerospike.rst @@ -11,7 +11,7 @@ Overview :platform: 64-bit Linux and OS X :synopsis: Aerospike client for Python. -``aerospike`` is a package which provides a Python client for Aerospike database clusters. +:py:mod:`aerospike` is a package which provides a Python client for Aerospike database clusters. The Aerospike client enables you to build an application in Python with an Aerospike cluster as its database. The client manages the connections to the @@ -140,6 +140,8 @@ Types A type for distinguishing a server-side null from a Python :py:obj:`None`. Replaces the constant ``aerospike.null``. + .. Needs cross reference to server docs + :return: a type representing the server-side type ``as_null``. .. versionadded:: 2.0.1 diff --git a/doc/client.rst b/doc/client.rst index 329ab109b7..7ca4a3009d 100755 --- a/doc/client.rst +++ b/doc/client.rst @@ -483,7 +483,9 @@ Numeric Operations :param int offset: the value by which to increment the value in *bin*. :type offset: :py:class:`int` or :py:class:`float` :param dict meta: record metadata to be set. See :ref:`metadata_dict`. - :param dict policy: optional :ref:`aerospike_operate_policies`. Note: the ``exists`` policy option may not be: ``aerospike.POLICY_EXISTS_CREATE_OR_REPLACE`` nor ``aerospike.POLICY_EXISTS_REPLACE`` + .. Does this still apply? + + :param dict policy: optional :ref:`aerospike_operate_policies`. Note: the ``exists`` policy option may not be: :py:data:`aerospike.POLICY_EXISTS_CREATE_OR_REPLACE` nor :py:data:`aerospike.POLICY_EXISTS_REPLACE` :raises: a subclass of :exc:`~aerospike.exception.AerospikeError`. .. code-block:: python