mirror of
https://github.com/neovim/neovim.git
synced 2025-02-25 18:55:25 -06:00
docs: fix typos
Co-authored-by: Gregory Anders <greg@gpanders.com> Co-authored-by: Raphael <glephunter@gmail.com> Co-authored-by: C.D. MacEachern <craig.daniel.maceachern@gmail.com> Co-authored-by: himanoa <matsunoappy@gmail.com>
This commit is contained in:
parent
b75acd2f94
commit
a5c572bd44
@ -435,7 +435,7 @@ endfunction
|
|||||||
|
|
||||||
" Check if pyenv is available and a valid pyenv root can be found, then return
|
" Check if pyenv is available and a valid pyenv root can be found, then return
|
||||||
" their respective paths. If either of those is invalid, return two empty
|
" their respective paths. If either of those is invalid, return two empty
|
||||||
" strings, effectivly ignoring pyenv.
|
" strings, effectively ignoring pyenv.
|
||||||
function! s:check_for_pyenv() abort
|
function! s:check_for_pyenv() abort
|
||||||
let pyenv_path = resolve(exepath('pyenv'))
|
let pyenv_path = resolve(exepath('pyenv'))
|
||||||
|
|
||||||
|
@ -48,7 +48,7 @@ indent_style One of "tab" or "space". Sets the 'expandtab' option.
|
|||||||
indent_size A number indicating the size of a single indent.
|
indent_size A number indicating the size of a single indent.
|
||||||
Alternatively, use the value "tab" to use the value of
|
Alternatively, use the value "tab" to use the value of
|
||||||
the tab_width property. Sets the 'shiftwidth' and
|
the tab_width property. Sets the 'shiftwidth' and
|
||||||
'softtabstop'.
|
'softtabstop' options.
|
||||||
|
|
||||||
*editorconfig_insert_final_newline*
|
*editorconfig_insert_final_newline*
|
||||||
insert_final_newline "true" or "false" to ensure the file always has a
|
insert_final_newline "true" or "false" to ensure the file always has a
|
||||||
|
@ -517,7 +517,7 @@ groups are derived from the token's type and modifiers:
|
|||||||
• `@lsp.type.<type>.<ft>` for the type
|
• `@lsp.type.<type>.<ft>` for the type
|
||||||
• `@lsp.mod.<mod>.<ft>` for each modifier
|
• `@lsp.mod.<mod>.<ft>` for each modifier
|
||||||
• `@lsp.typemod.<type>.<mod>.<ft>` for each modifier
|
• `@lsp.typemod.<type>.<mod>.<ft>` for each modifier
|
||||||
Use |:Inspect| to view the higlights for a specific token. Use |:hi| or
|
Use |:Inspect| to view the highlights for a specific token. Use |:hi| or
|
||||||
|nvim_set_hl()| to change the appearance of semantic highlights: >vim
|
|nvim_set_hl()| to change the appearance of semantic highlights: >vim
|
||||||
|
|
||||||
hi @lsp.type.function guifg=Yellow " function names are yellow
|
hi @lsp.type.function guifg=Yellow " function names are yellow
|
||||||
|
@ -539,7 +539,7 @@ about the triggered autocommand. The most useful keys are
|
|||||||
|
|
||||||
For example, this allows you to set buffer-local mappings for some filetypes:
|
For example, this allows you to set buffer-local mappings for some filetypes:
|
||||||
>lua
|
>lua
|
||||||
vim.api.nvim.create_autocmd("FileType", {
|
vim.api.nvim_create_autocmd("FileType", {
|
||||||
pattern = "lua",
|
pattern = "lua",
|
||||||
callback = function(args)
|
callback = function(args)
|
||||||
vim.keymap.set('n', 'K', vim.lsp.buf.hover, { buffer = args.buf })
|
vim.keymap.set('n', 'K', vim.lsp.buf.hover, { buffer = args.buf })
|
||||||
|
@ -2001,7 +2001,7 @@ validate({opt}) *vim.validate()*
|
|||||||
vim.validate{arg1={{'foo'}, {'table', 'string'}}, arg2={'foo', {'table', 'string'}}}
|
vim.validate{arg1={{'foo'}, {'table', 'string'}}, arg2={'foo', {'table', 'string'}}}
|
||||||
--> NOP (success)
|
--> NOP (success)
|
||||||
|
|
||||||
vim.validate{arg1={1, {'string', table'}}}
|
vim.validate{arg1={1, {'string', 'table'}}}
|
||||||
--> error('arg1: expected string|table, got number')
|
--> error('arg1: expected string|table, got number')
|
||||||
<
|
<
|
||||||
|
|
||||||
|
@ -259,7 +259,7 @@ The following changes to existing APIs or features add new behavior.
|
|||||||
• API calls now show more information about where an exception happened.
|
• API calls now show more information about where an exception happened.
|
||||||
|
|
||||||
• The `win_viewport` UI event now contains information about virtual lines,
|
• The `win_viewport` UI event now contains information about virtual lines,
|
||||||
meaning that smooth scrolling can now be implemented more consistenlty.
|
meaning that smooth scrolling can now be implemented more consistently.
|
||||||
|
|
||||||
• The `:= {expr}` syntax can be used to evaluate a lua expression, as
|
• The `:= {expr}` syntax can be used to evaluate a lua expression, as
|
||||||
a shorter form of `:lua ={expr}`. `:=` and `:[range]=` without argument
|
a shorter form of `:lua ={expr}`. `:=` and `:[range]=` without argument
|
||||||
|
@ -4846,7 +4846,7 @@ A jump table for the options with a short description can be found at |Q_op|.
|
|||||||
pack/ packages |:packadd|
|
pack/ packages |:packadd|
|
||||||
parser/ |treesitter| syntax parsers
|
parser/ |treesitter| syntax parsers
|
||||||
plugin/ plugin scripts |write-plugin|
|
plugin/ plugin scripts |write-plugin|
|
||||||
query/ |treesitter| queries
|
queries/ |treesitter| queries
|
||||||
rplugin/ |remote-plugin| scripts
|
rplugin/ |remote-plugin| scripts
|
||||||
spell/ spell checking files |spell|
|
spell/ spell checking files |spell|
|
||||||
syntax/ syntax files |mysyntaxfile|
|
syntax/ syntax files |mysyntaxfile|
|
||||||
@ -7256,7 +7256,7 @@ A jump table for the options with a short description can be found at |Q_op|.
|
|||||||
*'writedelay'* *'wd'*
|
*'writedelay'* *'wd'*
|
||||||
'writedelay' 'wd' number (default 0)
|
'writedelay' 'wd' number (default 0)
|
||||||
global
|
global
|
||||||
Only takes effect toghether with 'redrawdebug'.
|
Only takes effect together with 'redrawdebug'.
|
||||||
The number of milliseconds to wait after each line or each flush
|
The number of milliseconds to wait after each line or each flush
|
||||||
|
|
||||||
vim:tw=78:ts=8:noet:ft=help:norl:
|
vim:tw=78:ts=8:noet:ft=help:norl:
|
||||||
|
@ -105,7 +105,7 @@ with your plugin name: >
|
|||||||
local M = {}
|
local M = {}
|
||||||
|
|
||||||
M.check = function()
|
M.check = function()
|
||||||
vim.health.report_start("my_plugin report")
|
vim.health.report_start("foo report")
|
||||||
-- make sure setup function parameters are ok
|
-- make sure setup function parameters are ok
|
||||||
if check_setup() then
|
if check_setup() then
|
||||||
vim.health.report_ok("Setup is correct")
|
vim.health.report_ok("Setup is correct")
|
||||||
|
@ -242,7 +242,7 @@ argument.
|
|||||||
*-ll*
|
*-ll*
|
||||||
-ll {script} [args]
|
-ll {script} [args]
|
||||||
Execute a lua script, similarly to |-l|, but the editor is not
|
Execute a lua script, similarly to |-l|, but the editor is not
|
||||||
initialized. This gives a lua enviroment similar to a worker
|
initialized. This gives a lua environment similar to a worker
|
||||||
thread. See |lua-loop-threading|.
|
thread. See |lua-loop-threading|.
|
||||||
|
|
||||||
Unlike `-l` no prior arguments are allowed.
|
Unlike `-l` no prior arguments are allowed.
|
||||||
@ -1394,7 +1394,7 @@ result in Neovim looking for configuration files in `$XDG_CONFIG_HOME/neovim`
|
|||||||
instead of `$XDG_CONFIG_HOME/nvim`.
|
instead of `$XDG_CONFIG_HOME/nvim`.
|
||||||
|
|
||||||
Note: Similarly to the $XDG environment variables, when
|
Note: Similarly to the $XDG environment variables, when
|
||||||
`$XDG_CONFIG_HOME/nvim` is mentionned, it should be understood as
|
`$XDG_CONFIG_HOME/nvim` is mentioned, it should be understood as
|
||||||
`$XDG_CONFIG_HOME/$NVIM_APPNAME`.
|
`$XDG_CONFIG_HOME/$NVIM_APPNAME`.
|
||||||
|
|
||||||
LOG FILE *log* *$NVIM_LOG_FILE* *E5430*
|
LOG FILE *log* *$NVIM_LOG_FILE* *E5430*
|
||||||
|
@ -14,7 +14,7 @@ Supported platforms *supported-platforms*
|
|||||||
`System` `Tier` `Versions` `Tested versions`
|
`System` `Tier` `Versions` `Tested versions`
|
||||||
Linux 1 >= 2.6.32, glibc >= 2.12 Ubuntu 22.04
|
Linux 1 >= 2.6.32, glibc >= 2.12 Ubuntu 22.04
|
||||||
macOS (Intel) 1 >= 10.15 macOS 12
|
macOS (Intel) 1 >= 10.15 macOS 12
|
||||||
Windows 64-bit 1 >= 8 (see note below) Windows Server 2019
|
Windows 64-bit 1 >= 8 (see note below) Windows Server 2022
|
||||||
FreeBSD 1 >= 10 FreeBSD 13
|
FreeBSD 1 >= 10 FreeBSD 13
|
||||||
macOS (M1) 2 >= 10.15
|
macOS (M1) 2 >= 10.15
|
||||||
OpenBSD 2 >= 7
|
OpenBSD 2 >= 7
|
||||||
|
@ -255,6 +255,8 @@ Highlight groups:
|
|||||||
|hl-TermCursorNC|
|
|hl-TermCursorNC|
|
||||||
|hl-WinSeparator| highlights window separators
|
|hl-WinSeparator| highlights window separators
|
||||||
|hl-Whitespace| highlights 'listchars' whitespace
|
|hl-Whitespace| highlights 'listchars' whitespace
|
||||||
|
|hl-WinBar| highlights 'winbar'
|
||||||
|
|hl-WinBarNC| highlights non-current window 'winbar'
|
||||||
|
|
||||||
Input/Mappings:
|
Input/Mappings:
|
||||||
ALT (|META|) chords always work (even in the |TUI|). Map |<M-| with any key:
|
ALT (|META|) chords always work (even in the |TUI|). Map |<M-| with any key:
|
||||||
|
@ -11,7 +11,7 @@ local M = {}
|
|||||||
---@class ModuleFindOpts
|
---@class ModuleFindOpts
|
||||||
---@field all? boolean Search for all matches (defaults to `false`)
|
---@field all? boolean Search for all matches (defaults to `false`)
|
||||||
---@field rtp? boolean Search for modname in the runtime path (defaults to `true`)
|
---@field rtp? boolean Search for modname in the runtime path (defaults to `true`)
|
||||||
---@field patterns? string[] Paterns to use (defaults to `{"/init.lua", ".lua"}`)
|
---@field patterns? string[] Patterns to use (defaults to `{"/init.lua", ".lua"}`)
|
||||||
---@field paths? string[] Extra paths to search for modname
|
---@field paths? string[] Extra paths to search for modname
|
||||||
|
|
||||||
---@class ModuleInfo
|
---@class ModuleInfo
|
||||||
@ -469,7 +469,7 @@ end
|
|||||||
---@class ProfileOpts
|
---@class ProfileOpts
|
||||||
---@field loaders? boolean Add profiling to the loaders
|
---@field loaders? boolean Add profiling to the loaders
|
||||||
|
|
||||||
--- Debug function that wrapps all loaders and tracks stats
|
--- Debug function that wraps all loaders and tracks stats
|
||||||
---@private
|
---@private
|
||||||
---@param opts ProfileOpts?
|
---@param opts ProfileOpts?
|
||||||
function M._profile(opts)
|
function M._profile(opts)
|
||||||
|
@ -655,7 +655,7 @@ end
|
|||||||
--- vim.validate{arg1={{'foo'}, {'table', 'string'}}, arg2={'foo', {'table', 'string'}}}
|
--- vim.validate{arg1={{'foo'}, {'table', 'string'}}, arg2={'foo', {'table', 'string'}}}
|
||||||
--- --> NOP (success)
|
--- --> NOP (success)
|
||||||
---
|
---
|
||||||
--- vim.validate{arg1={1, {'string', table'}}}
|
--- vim.validate{arg1={1, {'string', 'table'}}}
|
||||||
--- --> error('arg1: expected string|table, got number')
|
--- --> error('arg1: expected string|table, got number')
|
||||||
---
|
---
|
||||||
--- </pre>
|
--- </pre>
|
||||||
|
@ -68,7 +68,7 @@ function FoldInfo:add_stop(lnum)
|
|||||||
self.stop_counts[lnum] = (self.stop_counts[lnum] or 0) + 1
|
self.stop_counts[lnum] = (self.stop_counts[lnum] or 0) + 1
|
||||||
end
|
end
|
||||||
|
|
||||||
---@packag
|
---@package
|
||||||
---@param lnum integer
|
---@param lnum integer
|
||||||
---@return integer
|
---@return integer
|
||||||
function FoldInfo:get_start(lnum)
|
function FoldInfo:get_start(lnum)
|
||||||
|
@ -4180,7 +4180,7 @@ describe('API', function()
|
|||||||
meths.cmd({ cmd = "buffers", mods = { filter = { pattern = "foo", force = true } } },
|
meths.cmd({ cmd = "buffers", mods = { filter = { pattern = "foo", force = true } } },
|
||||||
{ output = true }))
|
{ output = true }))
|
||||||
|
|
||||||
-- with emsg_silent = true error is suppresed
|
-- with emsg_silent = true error is suppressed
|
||||||
feed([[:lua vim.api.nvim_cmd({ cmd = 'call', mods = { emsg_silent = true } }, {})<CR>]])
|
feed([[:lua vim.api.nvim_cmd({ cmd = 'call', mods = { emsg_silent = true } }, {})<CR>]])
|
||||||
eq('', meths.cmd({ cmd = 'messages' }, { output = true }))
|
eq('', meths.cmd({ cmd = 'messages' }, { output = true }))
|
||||||
-- error from the next command typed is not suppressed #21420
|
-- error from the next command typed is not suppressed #21420
|
||||||
|
@ -1367,7 +1367,7 @@ int main()
|
|||||||
exec_lua([[
|
exec_lua([[
|
||||||
local text = ...
|
local text = ...
|
||||||
vim.api.nvim_buf_set_lines(bufnr, 0, -1, false, vim.fn.split(text, "\n"))
|
vim.api.nvim_buf_set_lines(bufnr, 0, -1, false, vim.fn.split(text, "\n"))
|
||||||
vim.wait(15) -- wait fot debounce
|
vim.wait(15) -- wait for debounce
|
||||||
]], test.text2)
|
]], test.text2)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
@ -3877,14 +3877,14 @@ describe('LSP', function()
|
|||||||
|
|
||||||
local send_event
|
local send_event
|
||||||
require('vim.lsp._watchfiles')._watchfunc = function(_, _, callback)
|
require('vim.lsp._watchfiles')._watchfunc = function(_, _, callback)
|
||||||
local stoppped = false
|
local stopped = false
|
||||||
send_event = function(...)
|
send_event = function(...)
|
||||||
if not stoppped then
|
if not stopped then
|
||||||
callback(...)
|
callback(...)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
return function()
|
return function()
|
||||||
stoppped = true
|
stopped = true
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user