aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc
diff options
context:
space:
mode:
Diffstat (limited to 'runtime/doc')
-rw-r--r--runtime/doc/api.txt3
-rw-r--r--runtime/doc/builtin.txt4
-rw-r--r--runtime/doc/deprecated.txt2
-rw-r--r--runtime/doc/diagnostic.txt2
-rw-r--r--runtime/doc/filetype.txt2
-rw-r--r--runtime/doc/insert.txt5
-rw-r--r--runtime/doc/lsp.txt17
-rw-r--r--runtime/doc/lua.txt6
-rw-r--r--runtime/doc/luaref.txt2
-rw-r--r--runtime/doc/news.txt19
-rw-r--r--runtime/doc/options.txt2
-rw-r--r--runtime/doc/sign.txt4
-rw-r--r--runtime/doc/syntax.txt17
-rw-r--r--runtime/doc/vim_diff.txt1
-rw-r--r--runtime/doc/windows.txt4
15 files changed, 62 insertions, 28 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt
index a714034e50..e096231724 100644
--- a/runtime/doc/api.txt
+++ b/runtime/doc/api.txt
@@ -2924,8 +2924,7 @@ nvim_buf_set_extmark({buffer}, {ns_id}, {line}, {col}, {opts})
'nowrap', otherwise the same as "trunc".
• ephemeral : for use with |nvim_set_decoration_provider()|
callbacks. The mark will only be used for the current
- redraw cycle, and not be permantently stored in the
- buffer.
+ redraw cycle, and not be permanently stored in the buffer.
• right_gravity : boolean that indicates the direction the
extmark will be shifted in when new text is inserted (true
for right, false for left). Defaults to true.
diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt
index 9214b33519..2ba464e80c 100644
--- a/runtime/doc/builtin.txt
+++ b/runtime/doc/builtin.txt
@@ -6462,7 +6462,7 @@ matchfuzzy({list}, {str} [, {dict}]) *matchfuzzy()*
Parameters: ~
• {list} (`any[]`)
• {str} (`string`)
- • {dict} (`string?`)
+ • {dict} (`table?`)
Return: ~
(`any`)
@@ -6492,7 +6492,7 @@ matchfuzzypos({list}, {str} [, {dict}]) *matchfuzzypos()*
Parameters: ~
• {list} (`any[]`)
• {str} (`string`)
- • {dict} (`string?`)
+ • {dict} (`table?`)
Return: ~
(`any`)
diff --git a/runtime/doc/deprecated.txt b/runtime/doc/deprecated.txt
index 68258fedb4..21f35637e6 100644
--- a/runtime/doc/deprecated.txt
+++ b/runtime/doc/deprecated.txt
@@ -42,7 +42,7 @@ LSP
• *vim.lsp.util.jump_to_location* Use |vim.lsp.util.show_document()| with
`{focus=true}` instead.
• *vim.lsp.buf.execute_command* Use |Client:exec_cmd()| instead.
-• *vim.lsp.buf.completion* Use |vim.lsp.completion.trigger()| instead.
+• *vim.lsp.buf.completion* Use |vim.lsp.completion.get()| instead.
• vim.lsp.buf_request_all The `error` key has been renamed to `err` inside
the result parameter of the handler.
• *vim.lsp.with()* Pass configuration to equivalent
diff --git a/runtime/doc/diagnostic.txt b/runtime/doc/diagnostic.txt
index bbc1d1de2c..2b891bde1b 100644
--- a/runtime/doc/diagnostic.txt
+++ b/runtime/doc/diagnostic.txt
@@ -122,7 +122,7 @@ with |vim.notify()|: >lua
-- Users can configure the handler
vim.diagnostic.config({
["my/notify"] = {
- log_level = vim.log.levels.INFO
+ log_level = vim.log.levels.INFO,
-- This handler will only receive "error" diagnostics.
severity = vim.diagnostic.severity.ERROR,
diff --git a/runtime/doc/filetype.txt b/runtime/doc/filetype.txt
index 2e0de44e56..a68d94828b 100644
--- a/runtime/doc/filetype.txt
+++ b/runtime/doc/filetype.txt
@@ -615,7 +615,7 @@ with interactive `git rebase`: >
:Reword " to pick this commit, but change the commit message
:Squash " to squash this commit into the previous one
-In addition, the following comamnd can be used to cycle between the different
+In addition, the following command can be used to cycle between the different
possibilities: >
:Cycle " to cycle between the previous commands
diff --git a/runtime/doc/insert.txt b/runtime/doc/insert.txt
index 31e6dd1ec4..51954e5449 100644
--- a/runtime/doc/insert.txt
+++ b/runtime/doc/insert.txt
@@ -1506,6 +1506,11 @@ both major engines implemented element, even if this is not in standards it
will be suggested. All other elements are not placed in suggestion list.
+LUA *ft-lua-omni*
+
+Lua |ftplugin| sets 'omnifunc' to |vim.lua_omnifunc()|.
+
+
PHP *ft-php-omni*
Completion of PHP code requires a tags file for completion of data from
diff --git a/runtime/doc/lsp.txt b/runtime/doc/lsp.txt
index f13a17cbef..3a2de6bc70 100644
--- a/runtime/doc/lsp.txt
+++ b/runtime/doc/lsp.txt
@@ -882,14 +882,23 @@ foldexpr({lnum}) *vim.lsp.foldexpr()*
Provides an interface between the built-in client and a `foldexpr`
function.
- To use, check for the "textDocument/foldingRange" capability in an
- |LspAttach| autocommand. Example: >lua
+ To use, set 'foldmethod' to "expr" and set the value of 'foldexpr': >lua
+ vim.o.foldmethod = 'expr'
+ vim.o.foldexpr = 'v:lua.vim.lsp.foldexpr()'
+<
+
+ Or use it only when supported by checking for the
+ "textDocument/foldingRange" capability in an |LspAttach| autocommand.
+ Example: >lua
+ vim.o.foldmethod = 'expr'
+ -- Default to treesitter folding
+ vim.o.foldexpr = 'v:lua.vim.treesitter.foldexpr()'
+ -- Prefer LSP folding if client supports it
vim.api.nvim_create_autocmd('LspAttach', {
callback = function(args)
local client = vim.lsp.get_client_by_id(args.data.client_id)
if client:supports_method('textDocument/foldingRange') then
local win = vim.api.nvim_get_current_win()
- vim.wo[win][0].foldmethod = 'expr'
vim.wo[win][0].foldexpr = 'v:lua.vim.lsp.foldexpr()'
end
end,
@@ -1870,7 +1879,7 @@ enable({enable}, {client_id}, {bufnr}, {opts})
• {opts} (`vim.lsp.completion.BufferOpts?`) See
|vim.lsp.completion.BufferOpts|.
-trigger({opts}) *vim.lsp.completion.trigger()*
+get({opts}) *vim.lsp.completion.get()*
Triggers LSP completion once in the current buffer.
Parameters: ~
diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt
index a99b050195..86cfc56693 100644
--- a/runtime/doc/lua.txt
+++ b/runtime/doc/lua.txt
@@ -4288,7 +4288,7 @@ Iter:last() *Iter:last()*
(`any`)
See also: ~
- • Iter.rpeek
+ • |Iter:rpeek()|
Iter:map({f}) *Iter:map()*
Maps the items of an iterator pipeline to the values returned by `f`.
@@ -4425,7 +4425,7 @@ Iter:rfind({f}) *Iter:rfind()*
(`any`)
See also: ~
- • Iter.find
+ • |Iter:find()|
Iter:rpeek() *Iter:rpeek()*
Gets the last value of a |list-iterator| without consuming it.
@@ -4444,7 +4444,7 @@ Iter:rpeek() *Iter:rpeek()*
(`any`)
See also: ~
- • Iter.last
+ • |Iter:last()|
Iter:rskip({n}) *Iter:rskip()*
Discards `n` values from the end of a |list-iterator| pipeline.
diff --git a/runtime/doc/luaref.txt b/runtime/doc/luaref.txt
index cd0b648560..ffcd537d7b 100644
--- a/runtime/doc/luaref.txt
+++ b/runtime/doc/luaref.txt
@@ -3905,7 +3905,7 @@ package.cpath *package.cpath*
variable `LUA_CPATH` (plus another default path defined in
`luaconf.h`).
-package.loaded *package.loaded()*
+package.loaded *package.loaded*
A table used by `require` to control which modules are already loaded.
When you require a module `modname` and `package.loaded[modname]` is
not false, `require` simply returns the value stored there.
diff --git a/runtime/doc/news.txt b/runtime/doc/news.txt
index 54a67ebb59..f7f86237f6 100644
--- a/runtime/doc/news.txt
+++ b/runtime/doc/news.txt
@@ -29,7 +29,8 @@ LSP
• `vim.lsp.buf.document_symbol()` uses the |location-list| by default. Use
`vim.lsp.buf.document_symbol({ loclist = false })` to use the |quickfix|
list.
-
+• `vim.lsp.completion.trigger()` has been renamed to
+ |vim.lsp.completion.get()|.
OPTIONS
@@ -70,12 +71,6 @@ BUILD
• Translations are turned off by default. Enable by building Nvim with the
CMake flag `ENABLE_TRANSLATIONS=ON`.
-DEFAULTS
-
-• 'number', 'relativenumber', 'signcolumn', and 'foldcolumn' are disabled in
- |terminal| buffers. See |terminal-config| for an example of changing these defaults.
-• 'diffopt' default includes "linematch:40".
-
DIAGNOSTICS
• The "underline" diagnostics handler sorts diagnostics by severity when using
@@ -247,6 +242,15 @@ DEFAULTS
• |[[| and |]]| in Normal mode jump between shell prompts for shells which emit
OSC 133 sequences ("shell integration" or "semantic prompts").
+• Options:
+ • 'diffopt' default includes "linematch:40".
+ • 'number', 'relativenumber', 'signcolumn', and 'foldcolumn' are disabled in
+ |terminal| buffers. |terminal-config| shows how to change these defaults.
+
+• Options:
+ • Lua |ftplugin| sets 'omnifunc' to "v:lua.vim.lua_omnifunc".
+ • Lua |ftplugin| sets 'foldexpr' to "v:lua.vim.treesitter.foldexpr()".
+
• Snippet:
• `<Tab>` in Insert and Select mode maps to `vim.snippet.jump({ direction = 1 })`
when a snippet is active and jumpable forwards.
@@ -362,6 +366,7 @@ PERFORMANCE
significantly improving |treesitter-highlight| performance.
• Treesitter injection query iteration is now asynchronous, making edits in
large buffers with combined injections much quicker.
+• 10x reduction in blocking time when attaching an LSP to a large buffer.
PLUGINS
diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index e42fb4f9e4..7aca0268c6 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -1528,7 +1528,7 @@ A jump table for the options with a short description can be found at |Q_op|.
order.
*'completeopt'* *'cot'*
-'completeopt' 'cot' string (default "menu,preview")
+'completeopt' 'cot' string (default "menu,popup")
global or local to buffer |global-local|
A comma-separated list of options for Insert mode completion
|ins-completion|. The supported values are:
diff --git a/runtime/doc/sign.txt b/runtime/doc/sign.txt
index 9895b606fd..beae7b3ae7 100644
--- a/runtime/doc/sign.txt
+++ b/runtime/doc/sign.txt
@@ -123,8 +123,8 @@ See |sign_define()| for the equivalent Vim script function.
numhl={group}
Highlighting group used for the line number on the line where
- the sign is placed. Overrides |hl-LineNr|, |hl-LineNrAbove|,
- |hl-LineNrBelow|, and |hl-CursorLineNr|.
+ the sign is placed. Combines with |hl-LineNr|,
+ |hl-LineNrAbove|, |hl-LineNrBelow|, and |hl-CursorLineNr|.
text={text} *E239*
Define the text that is displayed when there is no icon or the
diff --git a/runtime/doc/syntax.txt b/runtime/doc/syntax.txt
index 00486a49db..2feee0a511 100644
--- a/runtime/doc/syntax.txt
+++ b/runtime/doc/syntax.txt
@@ -336,7 +336,7 @@ Upon loading a file, Vim finds the relevant syntax file as follows:
==============================================================================
4. Conversion to HTML *convert-to-HTML* *2html.vim*
-The old to html converter has ben replaced by a Lua version and the
+The old to html converter has been replaced by a Lua version and the
documentation has been moved to |:TOhtml|.
==============================================================================
@@ -811,6 +811,21 @@ doesn't work for you, or you don't edit Progress at all, use this in your
startup vimrc: >
:let filetype_w = "cweb"
+CSHARP *cs.vim* *ft-cs-syntax*
+
+C# raw string literals may use any number of quote marks to encapsulate the
+block, and raw interpolated string literals may use any number of braces to
+encapsulate the interpolation, e.g. >
+
+ $$$""""Hello {{{name}}}""""
+<
+By default, Vim highlights 3-8 quote marks, and 1-8 interpolation braces.
+The maximum numbers of quotes and braces recognized can configured using the
+following variables:
+
+ Variable Default ~
+ g:cs_raw_string_quote_count 8
+ g:cs_raw_string_interpolation_brace_count 8
DART *dart.vim* *ft-dart-syntax*
diff --git a/runtime/doc/vim_diff.txt b/runtime/doc/vim_diff.txt
index 9bd23313e3..df79d25198 100644
--- a/runtime/doc/vim_diff.txt
+++ b/runtime/doc/vim_diff.txt
@@ -46,6 +46,7 @@ Defaults *defaults* *nvim-defaults*
- 'commentstring' defaults to ""
- 'compatible' is always disabled
- 'complete' excludes "i"
+- 'completeopt' defaults to "menu,popup"
- 'define' defaults to "". The C ftplugin sets it to "^\\s*#\\s*define"
- 'diffopt' defaults to "internal,filler,closeoff,linematch:40"
- 'directory' defaults to ~/.local/state/nvim/swap// (|xdg|), auto-created
diff --git a/runtime/doc/windows.txt b/runtime/doc/windows.txt
index 6dd90f7e49..89a9c7dda3 100644
--- a/runtime/doc/windows.txt
+++ b/runtime/doc/windows.txt
@@ -1272,7 +1272,7 @@ list of buffers. |unlisted-buffer|
:w foobar | sp #
< Also see |+cmd|.
-:[N]bn[ext][!] [+cmd] [N] *:bn* *:bnext* *[b* *E87*
+:[N]bn[ext][!] [+cmd] [N] *:bn* *:bnext* *]b* *E87*
Go to [N]th next buffer in buffer list. [N] defaults to one.
Wraps around the end of the buffer list.
See |:buffer-!| for [!].
@@ -1290,7 +1290,7 @@ list of buffers. |unlisted-buffer|
Wraps around the end of the buffer list. Uses 'switchbuf'
Also see |+cmd|.
-:[N]bN[ext][!] [+cmd] [N] *:bN* *:bNext* *:bp* *:bprevious* *]b* *E88*
+:[N]bN[ext][!] [+cmd] [N] *:bN* *:bNext* *:bp* *:bprevious* *[b* *E88*
:[N]bp[revious][!] [+cmd] [N]
Go to [N]th previous buffer in buffer list. [N] defaults to
one. Wraps around the start of the buffer list.