From e6688e1db293e24dafc65ca28efd2fca59799941 Mon Sep 17 00:00:00 2001 From: kyren Date: Sun, 5 Aug 2018 09:51:32 -0400 Subject: [PATCH] very small doc fixes --- Cargo.toml | 4 ++-- README.md | 4 ++-- src/lua.rs | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 8b5ed36..5e6ed59 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -20,8 +20,8 @@ default = ["builtin-lua"] # assumptions about the linked lua library: # * LUA_INTEGER is long long # * LUA_NUMBER as double -# * LUA_EXTRASPACE is sizeof(void*) -# * LUAI_MAXSTACK is 1000000 +# * LUA_EXTRASPACE is at least pointer sized and has at least pointer alignment. +# * LUAI_MAXSTACK is 1_000_000 builtin-lua = ["cc"] [dependencies] diff --git a/README.md b/README.md index 4ec5e49..b687c0a 100644 --- a/README.md +++ b/README.md @@ -116,7 +116,7 @@ If you encounter them, a bug report would be very welcome: `cfg!(debug_assertions)` is true, Lua is built with the `LUA_USE_APICHECK` define set. Any abort caused by this internal Lua API checking is *absolutely* a bug, particularly because without `LUA_USE_APICHECK` it would - generally be unsafe. + generally cause UB. * Lua C API errors are handled by lonjmp. *ALL* instances where the Lua C API would longjmp should be protected from Rust, except in internal callbacks where this is intentional. If you detect that `rlua` is triggering a @@ -128,4 +128,4 @@ If you encounter them, a bug report would be very welcome: `rlua` instances are supposed to remain fully usable in the face of user triggered panics. This guarantee does NOT extend to panics marked with "rlua internal error" simply because that is already indicative of a - separate bug, but it may be true in many cases anyway. + separate bug. diff --git a/src/lua.rs b/src/lua.rs index ba2d861..a2317c5 100644 --- a/src/lua.rs +++ b/src/lua.rs @@ -381,7 +381,7 @@ impl Lua { /// Coerces a Lua value to an integer. /// - /// The value must be an integer, or a floating point number or a string that can be converted + /// The value must be an integer, or a floating point number, or a string that can be converted /// to an integer. Refer to the Lua manual for details. pub fn coerce_integer(&self, v: Value) -> Result { match v {