From 27fdff9ecab66d571f6f9412b91bba06eaeece03 Mon Sep 17 00:00:00 2001 From: Marcus Tillmanns Date: Mon, 15 Jan 2024 10:06:51 +0100 Subject: [PATCH] Fix safety.rst typo The documentation states SOL_SAFE_FUNCTION, but in code its called SOL_SAFE_FUNCTION(S) --- documentation/source/safety.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/source/safety.rst b/documentation/source/safety.rst index f4b4b4d2..f29bb11f 100644 --- a/documentation/source/safety.rst +++ b/documentation/source/safety.rst @@ -30,7 +30,7 @@ Safety Config * All calls from Lua will have their arguments checked * Turned on by default with clang++, g++ and VC++ if a basic check for building in debug mode is detected (lack of ``_NDEBUG`` or similar compiler-specific checks) -``SOL_SAFE_FUNCTION`` triggers the following change: +``SOL_SAFE_FUNCTIONS`` triggers the following change: * All uses of ``sol::function`` and ``sol::stack_function`` will default to ``sol::protected_function`` and ``sol::stack_protected_function``, respectively, rather than ``sol::unsafe_function`` and ``sol::stack_unsafe_function`` - Note this does not apply to ``sol::stack_aligned_function``: this variant must always be unprotected due to stack positioning requirements, especially in use with ``sol::stack_count`` * Will make any ``sol::state_view::script`` calls default to their safe variants if there is no supplied environment or error handler function