Skip to content
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

Jump to bottom

Update docs for the 'fiber:join' method #3842

Merged
merged 1 commit into from
Aug 15, 2024
Merged

Update docs for the 'fiber:join' method #3842

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
5 changes: 4 additions & 1 deletion doc/reference/reference_lua/fiber.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1320,7 +1320,7 @@ API reference

.. _fiber_object-join:

.. method:: join()
.. method:: join([timeout])

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

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

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

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

Possible errors: the fiber is already joined by concurrent ``fiber:join()``.

**Example:**

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