From a025d843dfe5a251a8b2284522a7165a93524e17 Mon Sep 17 00:00:00 2001 From: Benoit Germain Date: Thu, 12 Dec 2024 17:46:57 +0100 Subject: Clarify documentation on the callback provided to lanes.finally() --- docs/index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/index.html b/docs/index.html index bfa2615..bd7b1d8 100644 --- a/docs/index.html +++ b/docs/index.html @@ -486,7 +486,7 @@ Only the last registered finalizer is kept. It can be cleared by passing nil or nothing.
The finalizer is called unprotected from inside __gc metamethod of Lanes's Universe. Therefore, if your finalizer raises an error, Lua rules regarding errors in finalizers apply normally.
The installed function is called after all free-running lanes got a chance to terminate (see shutdown_timeout), but before lindas become unusable.
- The finalizer receives a single argument, a bool indicating whether some Lanes are still running or not at that point. It is possible to inspect them with tracking.
+ The finalizer receives a single argument, a bool indicating whether all Lanes are successfully terminated at that point. It is possible to inspect them with tracking.
If there are still running lanes when the finalizer returns: Lanes will throw a C++ std::logic_error if the finalizer returned "throw". Any other value will cause Lanes to freeze forever.

-- cgit v1.2.3-55-g6feb