Merge pull request #533 from tinyleolin/docs/improve-api-versioning

improve api versioning

Author: CppCXY

crates/emmylua_code_analysis/resources/std/global.lua

@@ -30,7 +30,8 @@ function assert(v, ...) end
 ---| "restart" # restarts automatic execution of the garbage collector.
 ---| "count" # returns the total memory in use by Lua in Kbytes. The value has a fractional part, so that it multiplied by 1024 gives the exact number of bytes in use by Lua (except for overflows).
 ---| "step" # performs a garbage-collection step. The step "size" is controlled by `arg`. With a zero value, the collector will perform one basic (indivisible) step. For non-zero values, the collector will perform as if Lua had allocated that amount of memory (in KBytes). Returns true if the step finished a collection cycle.
----| "setpause" # sets `arg` as the new value for the *pause* of the collector (see §2.5). Returns the previous value for *pause`.
+---| "setpause" # sets `arg` as the new value for the *pause* of the collector (see §2.5). Returns the previous value for *pause*.
+---| "setstepmul" # sets `arg` as the new value for the *step multiplier* of the collector (see §2.5). Returns the previous value for *step*.
 ---| "incremental" # Change the collector mode to incremental. This option can be followed by three numbers: the garbage-collector pause, the step multiplier, and the step size.
 ---| "generational" # Change the collector mode to generational. This option can be followed by two numbers: the garbage-collector minor multiplier and the major multiplier.
 ---| "isrunning" # returns a boolean that tells whether the collector is running (i.e., not stopped).
@@ -274,6 +275,8 @@ function rawequal(v1, v2) end
 ---@return std.RawGet<T, K>
 function rawget(table, index) end
 
+---@version >5.2
+---
 --- Returns the length of the object `v`, which must be a table or a string, without
 --- invoking any metamethod. Returns an integer number.
 ---@param v string|table

crates/emmylua_code_analysis/resources/std/math.lua

@@ -51,7 +51,7 @@ function math.atan(y, x) end
 --- Returns the smallest integer larger than or equal to `x`.
 ---@param x number
 ---@return integer
-function math.ceil(x) return 0 end
+function math.ceil(x) end
 
 ---
 --- Returns the cosine of `x` (assumed to be in radians).
@@ -108,6 +108,7 @@ function math.log(x, base) end
 ---@return number
 function math.max(x, ...) end
 
+---@version >5.3
 ---
 --- An integer with the maximum value for an integer.
 ---@type integer
@@ -122,6 +123,7 @@ math.maxinteger = nil
 ---@return number
 function math.min(x, ...) end
 
+---@version >5.3
 ---
 --- An integer with the minimum value for an integer.
 ---@type integer
@@ -208,15 +210,15 @@ function math.type(x) end
 ---@return boolean
 function math.ult(m, n) end
 
----@version 5.1, JIT
+---@version 5.1, 5.2, JIT
 ---
 --- Returns the value of `x` raised to the power `y`. (x^y)
 ---@param x number The base
 ---@param y number The exponent
 ---@return number
 function math.pow(x, y) end
 
----@version 5.1, JIT
+---@version 5.1, 5.2, JIT
 ---
 --- Returns the arc tangent of `y/x` (in radians), but uses the signs of both
 --- parameters to find the quadrant of the result. (It also handles correctly
@@ -235,4 +237,41 @@ function math.atan2(y, x) end
 ---@return number
 function math.log10(x) end
 
+---@version 5.1, 5.2, JIT
+---
+--- Returns the hyperbolic cosine of `x`.
+---@param x number
+---@return number
+function math.cosh(x) end
+
+---@version 5.1, 5.2, JIT
+---
+--- Returns the hyperbolic sine of `x`.
+---@param x number
+---@return number
+function math.sinh(x) end
+
+---@version 5.1, 5.2, JIT
+---
+--- Returns the hyperbolic tangent of `x`.
+---@param x number
+---@return number
+function math.tanh(x) end
+
+---@version 5.1, 5.2, JIT
+---
+--- Returns `m` and `e` such that *x = m2^e*, `e` is an integer and the absolute
+--- value of `m` is in the range *[0.5, 1)* (or zero when `x` is zero).
+---@param x number
+---@return number, integer
+function math.frexp(x) end
+
+---@version 5.1, 5.2, JIT
+---
+--- Returns *m2e* (`e` should be an integer).
+---@param m number
+---@param e integer
+---@return number
+function math.ldexp(m, e) end
+
 return math

crates/emmylua_code_analysis/resources/std/table.lua

@@ -41,6 +41,7 @@ function table.concat(list, sep, i, j) end
 ---@return integer
 function table.insert(list, pos, value) end
 
+---@version > 5.3
 ---
 --- Moves elements from table a1 to table `a2`, performing the equivalent to
 --- the following multiple assignment: `a2[t]`,`··· = a1[f]`,`···,a1[e]`. The