Skip to content

Commit e85d720

Browse files
dima424658Dmitry Pankov
and
Dmitry Pankov
authored
Update docs for 'fiber:join' method (#3842)
Co-authored-by: Dmitry Pankov <dk.pankov@vk.team>
1 parent 9e57f6c commit e85d720

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

doc/reference/reference_lua/fiber.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1320,7 +1320,7 @@ API reference
13201320

13211321
.. _fiber_object-join:
13221322

1323-
.. method:: join()
1323+
.. method:: join([timeout])
13241324

13251325
Join a fiber.
13261326
Joining a fiber enables you to get the result returned by the fiber's function.
@@ -1334,6 +1334,7 @@ API reference
13341334
:ref:`fiber.new() <fiber-new>` and is made joinable using
13351335
:ref:`fiber_object:set_joinable() <fiber_object-set_joinable>`.
13361336

1337+
:param number timeout: maximum number of seconds to wait for the completion of the fiber. Default: infinity.
13371338
:return:
13381339

13391340
The ``join`` method returns two values:
@@ -1350,6 +1351,8 @@ API reference
13501351

13511352
:rtype: boolean + result type, or boolean + struct error
13521353

1354+
Possible errors: the fiber is already joined by concurrent ``fiber:join()``.
1355+
13531356
**Example:**
13541357

13551358
The example below shows how to get the result returned by the fiber's function.

0 commit comments

Comments
 (0)