Skip to content

[CLIENT-4535] Replace literals with cross references for aerospike module constants #1046

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
juliannguyen4 wants to merge 1 commit into
base: dev
Choose a base branch
from
Draft

[CLIENT-4535] Replace literals with cross references for aerospike module constants #1046

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions aerospike_helpers/operations/bitwise_operations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <aerospike_bit_policies>` 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``.
Expand Down
9 changes: 5 additions & 4 deletions aerospike_helpers/operations/map_operations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`:

::

Expand Down Expand Up @@ -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.

::
Expand Down Expand Up @@ -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`

::

Expand Down Expand Up @@ -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.

::
Expand Down
4 changes: 3 additions & 1 deletion doc/aerospike.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
4 changes: 3 additions & 1 deletion doc/client.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading