Skip to content

Commit 908ab26

Browse files
committed
Add description of the name parameter
Since 3.1.0 there has been the ``name`` parameter,which returns the name of the error used at creation. Fixes #4150
1 parent a99dacd commit 908ab26

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

doc/reference/reference_lua/box_error/error_object.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -189,3 +189,13 @@ error_object
189189

190190
For the ``box.error.READONLY`` error, returns the current election term (see :ref:`box.info.election.term <box_info_election>`).
191191
This attribute may present if the :ref:`error reason <box_error-reason>` is ``election`` or ``synchro``.
192+
193+
.. _box_error-name:
194+
195+
.. data:: name
196+
197+
**Since:** :doc:`3.1.0 </release/3.1.0>`
198+
199+
Returns the name of the error used at creation.
200+
201+

0 commit comments

Comments
 (0)