Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
juliannguyen4 committed Nov 5, 2024
1 parent c444005 commit 666a3c6
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions doc/transaction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,11 @@ Methods
Initialize multi-record transaction (MRT), assign random transaction id and initialize
reads/writes hashmaps with default capacities. The default MRT timeout is 10 seconds.

If setting any parameters, both parameters must be specified.
For both parameters, an unsigned 32-bit integer must be passed and the minimum value is 16.
If neither is specified, both parameters are set to 128 by default.
For both parameters, an unsigned 32-bit integer must be passed and the minimum value should be 16.

:param reads_capacity: expected number of record reads in the MRT.
:param reads_capacity: expected number of record reads in the MRT. Defaults to ``128``.
:type reads_capacity: int, optional
:param writes_capacity: expected number of record writes in the MRT.
:param writes_capacity: expected number of record writes in the MRT. Defaults to ``128``.
:type writes_capacity: int, optional

.. py:attribute:: id
Expand Down

0 comments on commit 666a3c6

Please sign in to comment.