Skip to content

Commit 6721644

Browse files
committed
Update by comments
Fix comments recieved from SME
1 parent c170d0a commit 6721644

File tree

3 files changed

+15
-14
lines changed

3 files changed

+15
-14
lines changed

doc/reference/reference_lua/box_error.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,7 @@ Below is a list of ``box.error`` functions and related objects.
277277
- Set the specified error as the last system error explicitly
278278

279279
* - :doc:`./box_error/is`
280-
- Verify whether the specified argument is an error
280+
- Verify whether the specified argument is an error cdata object
281281

282282
* - :doc:`./box_error/error_object`
283283
- An object that defines an error

doc/reference/reference_lua/box_error/error_object.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,6 @@ error_object
196196

197197
**Since:** :doc:`3.1.0 </release/3.1.0>`
198198

199-
Returns the name of the error used at creation.
199+
Returns the name of the error.
200200

201201

doc/reference/reference_lua/box_error/is.rst

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,26 @@
44
box.error.is()
55
===============================================================================
66

7-
.. function:: box.error.is(object_name)
7+
.. function:: box.error.is(object)
88

99
**Since:** :doc:`3.2.0 </release/3.2.0>`
1010

11-
The ``box.error.is`` function allows verify whether the specified argument is an error.
11+
The ``box.error.is`` function allows verify whether the specified argument is an error cdata object.
1212

13-
:param object_name object_name: the subject of the request
13+
:param object object: the name of the othe object to be verified.
1414

1515
**Return type:**
1616
boolean
1717

1818
**Example**
1919

20-
.. code-block:: lua
21-
tarantool> box.error.is(box.error.new(box.error.UNKNOWN))
22-
---
23-
- true
24-
...
25-
tarantool> box.error.is('foo')
26-
---
27-
- false
28-
...
20+
.. code-block:: lua
21+
22+
tarantool> box.error.is(box.error.new(box.error.UNKNOWN))
23+
---
24+
- true
25+
...
26+
tarantool> box.error.is('foo')
27+
---
28+
- false
29+
...

0 commit comments

Comments
 (0)