Skip to content

Commit 22f9cbf

Browse files
MaddimaxThePhD
authored andcommitted
Fix safety.rst typo
The documentation states SOL_SAFE_FUNCTION, but in code its called SOL_SAFE_FUNCTION(S)
1 parent 8525c20 commit 22f9cbf

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

documentation/source/safety.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Safety Config
3030
* All calls from Lua will have their arguments checked
3131
* 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)
3232

33-
``SOL_SAFE_FUNCTION`` triggers the following change:
33+
``SOL_SAFE_FUNCTIONS`` triggers the following change:
3434
* 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``
3535
- 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``
3636
* Will make any ``sol::state_view::script`` calls default to their safe variants if there is no supplied environment or error handler function

0 commit comments

Comments
 (0)