aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBenoit Germain <benoit.germain@ubisoft.com>2024-12-12 17:46:57 +0100
committerBenoit Germain <benoit.germain@ubisoft.com>2024-12-12 17:46:57 +0100
commita025d843dfe5a251a8b2284522a7165a93524e17 (patch)
treedc02d5cee2c8be7bd363dce89096e5038423f358
parent6b93c4cc691e7ca0ec3e3073b6f91439706f59f7 (diff)
downloadlanes-a025d843dfe5a251a8b2284522a7165a93524e17.tar.gz
lanes-a025d843dfe5a251a8b2284522a7165a93524e17.tar.bz2
lanes-a025d843dfe5a251a8b2284522a7165a93524e17.zip
Clarify documentation on the callback provided to lanes.finally()
-rw-r--r--docs/index.html2
1 files changed, 1 insertions, 1 deletions
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 @@
486 Only the last registered finalizer is kept. It can be cleared by passing <tt>nil</tt> or nothing.<br /> 486 Only the last registered finalizer is kept. It can be cleared by passing <tt>nil</tt> or nothing.<br />
487 The finalizer is called unprotected from inside <tt>__gc</tt> metamethod of Lanes's Universe. Therefore, if your finalizer raises an error, Lua rules regarding errors in finalizers apply normally.<br /> 487 The finalizer is called unprotected from inside <tt>__gc</tt> metamethod of Lanes's Universe. Therefore, if your finalizer raises an error, Lua rules regarding errors in finalizers apply normally.<br />
488 The installed function is called after all free-running lanes got a chance to terminate (see <a href="#shutdown_timeout"><tt>shutdown_timeout</tt></a>), but before lindas become unusable.<br /> 488 The installed function is called after all free-running lanes got a chance to terminate (see <a href="#shutdown_timeout"><tt>shutdown_timeout</tt></a>), but before lindas become unusable.<br />
489 The finalizer receives a single argument, a <tt>bool</tt> indicating whether some Lanes are still running or not at that point. It is possible to inspect them with <a href="#tracking">tracking</a>.<br /> 489 The finalizer receives a single argument, a <tt>bool</tt> indicating whether all Lanes are successfully terminated at that point. It is possible to inspect them with <a href="#tracking">tracking</a>.<br />
490 If there are still running lanes when the finalizer returns: Lanes will throw a C++ <tt>std::logic_error</tt> if the finalizer returned <tt>"throw"</tt>. Any other value will cause Lanes to freeze forever. 490 If there are still running lanes when the finalizer returns: Lanes will throw a C++ <tt>std::logic_error</tt> if the finalizer returned <tt>"throw"</tt>. Any other value will cause Lanes to freeze forever.
491</p> 491</p>
492 492