aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2025-03-02 14:27:52 -0800
committerGitHub <noreply@github.com>2025-03-02 14:27:52 -0800
commitc4a0c1d3b02761626ffced32fe74b0df5b665a5f (patch)
treed83ec56eed5ee6b9f8c5683a84f3062b577a991e /src
parent0a5a0efda64ccc789cda25b90fa907f277006cd3 (diff)
downloadrneovim-c4a0c1d3b02761626ffced32fe74b0df5b665a5f.tar.gz
rneovim-c4a0c1d3b02761626ffced32fe74b0df5b665a5f.tar.bz2
rneovim-c4a0c1d3b02761626ffced32fe74b0df5b665a5f.zip
docs: misc #31996
Diffstat (limited to 'src')
-rw-r--r--src/nvim/api/vim.c3
-rw-r--r--src/nvim/eval.lua22
-rw-r--r--src/nvim/options.lua5
3 files changed, 17 insertions, 13 deletions
diff --git a/src/nvim/api/vim.c b/src/nvim/api/vim.c
index 3a89e44938..c734e2aa2a 100644
--- a/src/nvim/api/vim.c
+++ b/src/nvim/api/vim.c
@@ -1985,8 +1985,7 @@ Array nvim_get_mark(String name, Dict(empty) *opts, Arena *arena, Error *err)
/// the "highlights" key in {opts} is true. Each element of the array is a
/// |Dict| with these keys:
/// - start: (number) Byte index (0-based) of first character that uses the highlight.
-/// - group: (string) Name of highlight group. May be removed in the future, use
-/// `groups` instead.
+/// - group: (string) Deprecated. Use `groups` instead.
/// - groups: (array) Names of stacked highlight groups (highest priority last).
Dict nvim_eval_statusline(String str, Dict(eval_statusline) *opts, Arena *arena, Error *err)
FUNC_API_SINCE(8) FUNC_API_FAST
diff --git a/src/nvim/eval.lua b/src/nvim/eval.lua
index 1bb2bea502..3c06fc4fe3 100644
--- a/src/nvim/eval.lua
+++ b/src/nvim/eval.lua
@@ -1225,12 +1225,13 @@ M.funcs = {
args = 1,
base = 1,
desc = [=[
- Get the amount of indent for line {lnum} according the C
- indenting rules, as with 'cindent'.
+ Get the amount of indent for line {lnum} according the
+ |C-indenting| rules, as with 'cindent'.
The indent is counted in spaces, the value of 'tabstop' is
relevant. {lnum} is used just like in |getline()|.
When {lnum} is invalid -1 is returned.
- See |C-indenting|.
+
+ To get or set indent of lines in a string, see |vim.text.indent()|.
]=],
name = 'cindent',
@@ -5473,6 +5474,8 @@ M.funcs = {
|getline()|.
When {lnum} is invalid -1 is returned.
+ To get or set indent of lines in a string, see |vim.text.indent()|.
+
]=],
name = 'indent',
params = { { 'lnum', 'integer|string' } },
@@ -6595,9 +6598,8 @@ M.funcs = {
When {abbr} is there and it is |TRUE| use abbreviations
instead of mappings.
- When {dict} is there and it is |TRUE| return a dictionary
- containing all the information of the mapping with the
- following items: *mapping-dict*
+ When {dict} is |TRUE|, return a dictionary describing the
+ mapping, with these items: *mapping-dict*
"lhs" The {lhs} of the mapping as it would be typed
"lhsraw" The {lhs} of the mapping as raw bytes
"lhsrawalt" The {lhs} of the mapping as raw bytes, alternate
@@ -6659,7 +6661,7 @@ M.funcs = {
{ 'abbr', 'boolean' },
{ 'dict', 'true' },
},
- returns = 'string|table<string,any>',
+ returns = 'table<string,any>',
},
mapcheck = {
args = { 1, 3 },
@@ -8278,7 +8280,7 @@ M.funcs = {
endif
endfunc
call prompt_setcallback(bufnr(), function('s:TextEntered'))
-
+ <
]=],
name = 'prompt_setcallback',
params = { { 'buf', 'integer|string' }, { 'expr', 'string|function' } },
@@ -11225,7 +11227,9 @@ M.funcs = {
tags = { 'E6100' },
desc = [=[
Returns |standard-path| locations of various default files and
- directories.
+ directories. The locations are driven by |base-directories|
+ which you can configure via |$NVIM_APPNAME| or the `$XDG_…`
+ environment variables.
{what} Type Description ~
cache String Cache directory: arbitrary temporary
diff --git a/src/nvim/options.lua b/src/nvim/options.lua
index ff919bb522..d1d5a56082 100644
--- a/src/nvim/options.lua
+++ b/src/nvim/options.lua
@@ -5802,8 +5802,8 @@ local options = {
defaults = false,
desc = [=[
When on, mouse move events are delivered to the input queue and are
- available for mapping. The default, off, avoids the mouse movement
- overhead except when needed.
+ available for mapping |<MouseMove>|. The default, off, avoids the mouse
+ movement overhead except when needed.
Warning: Setting this option can make pending mappings to be aborted
when the mouse is moved.
]=],
@@ -5811,6 +5811,7 @@ local options = {
redraw = { 'ui_option' },
scope = { 'global' },
short_desc = N_('deliver mouse move events to input queue'),
+ tags = { 'mouse-hover' },
type = 'boolean',
varname = 'p_mousemev',
},