Merge pull request #2016 from C3pa/update-string-annotations

Make functions in string api accept numbers

Author: sumneko

meta/template/string.lua

@@ -5,7 +5,7 @@
 string = {}
 
 ---#DES 'string.byte'
----@param s  string
+---@param s  string|number
 ---@param i? integer
 ---@param j? integer
 ---@return integer ...
@@ -27,8 +27,8 @@ function string.char(byte, ...) end
 function string.dump(f, strip) end
 
 ---#DES 'string.find'
----@param s       string
----@param pattern string
+---@param s       string|number
+---@param pattern string|number
 ---@param init?   integer
 ---@param plain?  boolean
 ---@return integer start
@@ -38,30 +38,30 @@ function string.dump(f, strip) end
 function string.find(s, pattern, init, plain) end
 
 ---#DES 'string.format'
----@param s any
+---@param s string|number
 ---@param ... any
 ---@return string
 ---@nodiscard
 function string.format(s, ...) end
 
 ---#DES 'string.gmatch'
 ---#if VERSION <= 5.3 then
----@param s       string
----@param pattern string
+---@param s       string|number
+---@param pattern string|number
 ---@return fun():string, ...
 ---@nodiscard
 function string.gmatch(s, pattern) end
 ---#else
----@param s       string
----@param pattern string
+---@param s       string|number
+---@param pattern string|number
 ---@param init?   integer
 ---@return fun():string, ...
 function string.gmatch(s, pattern, init) end
 ---#end
 
 ---#DES 'string.gsub'
----@param s       string
----@param pattern string
+---@param s       string|number
+---@param pattern string|number
 ---@param repl    string|number|table|function
 ---@param n?      integer
 ---@return string
@@ -70,20 +70,20 @@ function string.gmatch(s, pattern, init) end
 function string.gsub(s, pattern, repl, n) end
 
 ---#DES 'string.len'
----@param s string
+---@param s string|number
 ---@return integer
 ---@nodiscard
 function string.len(s) end
 
 ---#DES 'string.lower'
----@param s string
+---@param s string|number
 ---@return string
 ---@nodiscard
 function string.lower(s) end
 
 ---#DES 'string.match'
----@param s       string
----@param pattern string
+---@param s       string|number
+---@param pattern string|number
 ---@param init?   integer
 ---@return any ...
 ---@nodiscard
@@ -107,29 +107,29 @@ function string.packsize(fmt) end
 
 ---#if VERSION <= 5.1 and not JIT then
 ---#DES 'string.rep<5.1'
----@param s    string
+---@param s    string|number
 ---@param n    integer
 ---@return string
 ---@nodiscard
 function string.rep(s, n) end
 ---#else
 ---#DES 'string.rep>5.2'
----@param s    string
+---@param s    string|number
 ---@param n    integer
----@param sep? string
+---@param sep? string|number
 ---@return string
 ---@nodiscard
 function string.rep(s, n, sep) end
 ---#end
 
 ---#DES 'string.reverse'
----@param s string
+---@param s string|number
 ---@return string
 ---@nodiscard
 function string.reverse(s) end
 
 ---#DES 'string.sub'
----@param s  string
+---@param s  string|number
 ---@param i  integer
 ---@param j? integer
 ---@return string
@@ -147,7 +147,7 @@ function string.sub(s, i, j) end
 function string.unpack(fmt, s, pos) end
 
 ---#DES 'string.upper'
----@param s string
+---@param s string|number
 ---@return string
 ---@nodiscard
 function string.upper(s) end

test/hover/init.lua

@@ -238,14 +238,14 @@ TEST [[
 string.<?sub?>()
 ]]
 [[
-function string.sub(s: string, i: integer, j?: integer)
+function string.sub(s: string|number, i: integer, j?: integer)
   -> string
 ]]
 
 TEST[[
 ('xx'):<?sub?>()
 ]]
-[[function string.sub(s: string, i: integer, j?: integer)
+[[function string.sub(s: string|number, i: integer, j?: integer)
   -> string]]
 
 TEST [[
@@ -272,7 +272,7 @@ TEST [[
 string.<?lower?>()
 ]]
 [[
-function string.lower(s: string)
+function string.lower(s: string|number)
   -> string
 ]]