aboutsummaryrefslogtreecommitdiff
path: root/manual
diff options
context:
space:
mode:
Diffstat (limited to 'manual')
-rw-r--r--manual/manual.of21
1 files changed, 12 insertions, 9 deletions
diff --git a/manual/manual.of b/manual/manual.of
index c69970d2..2a837b5e 100644
--- a/manual/manual.of
+++ b/manual/manual.of
@@ -5915,6 +5915,9 @@ previously pushed on the stack
5915on top of the library table. 5915on top of the library table.
5916These values are popped from the stack after the registration. 5916These values are popped from the stack after the registration.
5917 5917
5918A function with a @id{NULL} value represents a placeholder,
5919which is filled with @false.
5920
5918} 5921}
5919 5922
5920@APIEntry{void luaL_setmetatable (lua_State *L, const char *tname);| 5923@APIEntry{void luaL_setmetatable (lua_State *L, const char *tname);|
@@ -6397,7 +6400,7 @@ This means that any error @N{inside @T{f}} is not propagated;
6397instead, @id{pcall} catches the error 6400instead, @id{pcall} catches the error
6398and returns a status code. 6401and returns a status code.
6399Its first result is the status code (a boolean), 6402Its first result is the status code (a boolean),
6400which is true if the call succeeds without errors. 6403which is @true if the call succeeds without errors.
6401In such case, @id{pcall} also returns all results from the call, 6404In such case, @id{pcall} also returns all results from the call,
6402after this first result. 6405after this first result.
6403In case of any error, @id{pcall} returns @false plus the error object. 6406In case of any error, @id{pcall} returns @false plus the error object.
@@ -6603,7 +6606,7 @@ an object with type @T{"thread"}.
6603 6606
6604@LibEntry{coroutine.isyieldable ([co])| 6607@LibEntry{coroutine.isyieldable ([co])|
6605 6608
6606Returns true when the coroutine @id{co} can yield. 6609Returns @true when the coroutine @id{co} can yield.
6607The default for @id{co} is the running coroutine. 6610The default for @id{co} is the running coroutine.
6608 6611
6609A coroutine is yieldable if it is not the main thread and 6612A coroutine is yieldable if it is not the main thread and
@@ -6635,7 +6638,7 @@ If there is any error,
6635@LibEntry{coroutine.running ()| 6638@LibEntry{coroutine.running ()|
6636 6639
6637Returns the running coroutine plus a boolean, 6640Returns the running coroutine plus a boolean,
6638true when the running coroutine is the main one. 6641@true when the running coroutine is the main one.
6639 6642
6640} 6643}
6641 6644
@@ -6730,7 +6733,7 @@ If the loader returns any non-nil value,
6730@id{require} assigns the returned value to @T{package.loaded[modname]}. 6733@id{require} assigns the returned value to @T{package.loaded[modname]}.
6731If the loader does not return a non-nil value and 6734If the loader does not return a non-nil value and
6732has not assigned any value to @T{package.loaded[modname]}, 6735has not assigned any value to @T{package.loaded[modname]},
6733then @id{require} assigns @Rw{true} to this entry. 6736then @id{require} assigns @true to this entry.
6734In any case, @id{require} returns the 6737In any case, @id{require} returns the
6735final value of @T{package.loaded[modname]}. 6738final value of @T{package.loaded[modname]}.
6736Besides that value, @id{require} also returns as a second result 6739Besides that value, @id{require} also returns as a second result
@@ -7051,7 +7054,7 @@ otherwise, it returns @fail.
7051A third, optional numeric argument @id{init} specifies 7054A third, optional numeric argument @id{init} specifies
7052where to start the search; 7055where to start the search;
7053its default value @N{is 1} and can be negative. 7056its default value @N{is 1} and can be negative.
7054A value of @true as a fourth, optional argument @id{plain} 7057A @true as a fourth, optional argument @id{plain}
7055turns off the pattern matching facilities, 7058turns off the pattern matching facilities,
7056so the function does a plain @Q{find substring} operation, 7059so the function does a plain @Q{find substring} operation,
7057with no characters in @id{pattern} being considered magic. 7060with no characters in @id{pattern} being considered magic.
@@ -8077,7 +8080,7 @@ or @fail if @id{x} is not a number.
8077@LibEntry{math.ult (m, n)| 8080@LibEntry{math.ult (m, n)|
8078 8081
8079Returns a boolean, 8082Returns a boolean,
8080true if and only if integer @id{m} is below integer @id{n} when 8083@true if and only if integer @id{m} is below integer @id{n} when
8081they are compared as @x{unsigned integers}. 8084they are compared as @x{unsigned integers}.
8082 8085
8083} 8086}
@@ -8490,13 +8493,13 @@ When called without a @id{command},
8490@LibEntry{os.exit ([code [, close]])| 8493@LibEntry{os.exit ([code [, close]])|
8491 8494
8492Calls the @ANSI{exit} to terminate the host program. 8495Calls the @ANSI{exit} to terminate the host program.
8493If @id{code} is @Rw{true}, 8496If @id{code} is @true,
8494the returned status is @idx{EXIT_SUCCESS}; 8497the returned status is @idx{EXIT_SUCCESS};
8495if @id{code} is @Rw{false}, 8498if @id{code} is @false,
8496the returned status is @idx{EXIT_FAILURE}; 8499the returned status is @idx{EXIT_FAILURE};
8497if @id{code} is a number, 8500if @id{code} is a number,
8498the returned status is this number. 8501the returned status is this number.
8499The default value for @id{code} is @Rw{true}. 8502The default value for @id{code} is @true.
8500 8503
8501If the optional second argument @id{close} is true, 8504If the optional second argument @id{close} is true,
8502closes the Lua state before exiting. 8505closes the Lua state before exiting.