fix: doc errors

This commit is contained in:
Lewis Russell 2023-07-17 16:39:57 +01:00
parent 69d49727d7
commit 6e9b204afb
5 changed files with 9 additions and 8 deletions

View File

@ -826,8 +826,7 @@ vim.spell.check({str}) *vim.spell.check()*
• {str} (string) • {str} (string)
Return: ~ Return: ~
{[1]: string, [2]: string, [3]: string}[] List of tuples with three `{[1]: string, [2]: string, [3]: string}[]` List of tuples with three items:
items:
• The badly spelled word. • The badly spelled word.
• The type of the spelling error: "bad" spelling mistake "rare" rare • The type of the spelling error: "bad" spelling mistake "rare" rare
word "local" word only valid in another region "caps" word should word "local" word only valid in another region "caps" word should
@ -914,7 +913,7 @@ vim.iconv({str}, {from}, {to}, {opts}) *vim.iconv()*
• {str} (string) Text to convert • {str} (string) Text to convert
• {from} (number) Encoding of {str} • {from} (number) Encoding of {str}
• {to} (number) Target encoding • {to} (number) Target encoding
• {opts} table<string,|nil any> • {opts} table<string,any>|nil
Return: ~ Return: ~
(string|nil) Converted string if conversion succeeds, `nil` otherwise. (string|nil) Converted string if conversion succeeds, `nil` otherwise.

View File

@ -119,11 +119,11 @@ The following new APIs or features were added.
• Added an omnifunc implementation for Lua, |vim.lua_omnifunc()| • Added an omnifunc implementation for Lua, |vim.lua_omnifunc()|
• Added a new experimental |lua-loader| that byte-compiles and caches Lua files. • Added a new experimental |vim.loader| that byte-compiles and caches Lua files.
To enable the new loader, add the following at the top of your |init.lua|: >lua To enable the new loader, add the following at the top of your |init.lua|: >lua
vim.loader.enable() vim.loader.enable()
• Added |lua-version| for parsing and comparing version strings conforming to • Added |vim.version| for parsing and comparing version strings conforming to
the semver specification. the semver specification.
• When using Nvim inside tmux 3.2 or later, the default clipboard provider • When using Nvim inside tmux 3.2 or later, the default clipboard provider
@ -273,7 +273,7 @@ REMOVED FEATURES
The following deprecated functions or APIs were removed. The following deprecated functions or APIs were removed.
• `filetype.vim` is removed in favor of |lua-filetype| • `filetype.vim` is removed in favor of |vim.filetype|
(Note that filetype logic and tests still align with Vim, so additions or (Note that filetype logic and tests still align with Vim, so additions or
changes need to be contributed there first.) changes need to be contributed there first.)
See https://github.com/neovim/neovim/pull/20674. See https://github.com/neovim/neovim/pull/20674.

View File

@ -186,7 +186,7 @@ backwards-compatibility cost. Some examples:
Some features are built in that otherwise required external plugins: Some features are built in that otherwise required external plugins:
- Highlighting the yanked region, see |lua-highlight|. - Highlighting the yanked region, see |vim.highlight|.
ARCHITECTURE ARCHITECTURE

View File

@ -141,7 +141,7 @@ function vim.str_utfindex(str, index) end
--- @param str string Text to convert --- @param str string Text to convert
--- @param from number Encoding of {str} --- @param from number Encoding of {str}
--- @param to number Target encoding --- @param to number Target encoding
--- @param opts? table<string, any> --- @param opts? table<string,any>
--- @return string|nil Converted string if conversion succeeds, `nil` otherwise. --- @return string|nil Converted string if conversion succeeds, `nil` otherwise.
function vim.iconv(str, from, to, opts) end function vim.iconv(str, from, to, opts) end

View File

@ -363,6 +363,8 @@ function TLua2DoX_filter.filter(this, AppStamp, Filename)
magic = magic:gsub('^return%s+.*%((' .. type .. ')%)', 'return %1') magic = magic:gsub('^return%s+.*%((' .. type .. ')%)', 'return %1')
magic = magic:gsub('^return%s+.*%((' .. type .. '|nil)%)', 'return %1') magic = magic:gsub('^return%s+.*%((' .. type .. '|nil)%)', 'return %1')
end end
-- handle the return of vim.spell.check
magic = magic:gsub('({.*}%[%])', '`%1`')
magic_split = string_split(magic, ' ') magic_split = string_split(magic, ' ')
end end