summaryrefslogtreecommitdiff
path: root/src/lua.rs
diff options
context:
space:
mode:
Diffstat (limited to 'src/lua.rs')
-rw-r--r--src/lua.rs3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/lua.rs b/src/lua.rs
index 6608a4b..b799161 100644
--- a/src/lua.rs
+++ b/src/lua.rs
@@ -381,6 +381,9 @@ impl Lua {
}
/// Constructs a new Lua instance from an existing raw state.
+ ///
+ /// Once called, a returned Lua state is cached in the registry and can be retrieved
+ /// by calling this function again.
#[allow(clippy::missing_safety_doc)]
pub unsafe fn init_from_ptr(state: *mut ffi::lua_State) -> Lua {
let maybe_main_state = get_main_state(state);