aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc
diff options
context:
space:
mode:
authorLewis Russell <lewis6991@gmail.com>2022-10-06 16:04:34 +0100
committerGitHub <noreply@github.com>2022-10-06 16:04:34 +0100
commitd48ea0e3eae44a27cf8f0237c137b75e5298ab65 (patch)
tree6c060f502d43e88cc7d69fe37e31b8a65316c5b2 /runtime/doc
parentf7b175e049db9262a45ee1c5eb41a38bd5b8ac38 (diff)
parent1da7b4eb699fb04cc97dec389470fd0fbd64091d (diff)
downloadrneovim-d48ea0e3eae44a27cf8f0237c137b75e5298ab65.tar.gz
rneovim-d48ea0e3eae44a27cf8f0237c137b75e5298ab65.tar.bz2
rneovim-d48ea0e3eae44a27cf8f0237c137b75e5298ab65.zip
Merge pull request #20378 from folke/shared_annotations
Diffstat (limited to 'runtime/doc')
-rw-r--r--runtime/doc/lsp.txt18
-rw-r--r--runtime/doc/lua.txt22
2 files changed, 20 insertions, 20 deletions
diff --git a/runtime/doc/lsp.txt b/runtime/doc/lsp.txt
index 6d5c51c210..ae969491f7 100644
--- a/runtime/doc/lsp.txt
+++ b/runtime/doc/lsp.txt
@@ -723,7 +723,7 @@ get_buffers_by_client_id({client_id})
• {client_id} (number) client id
Return: ~
- list of buffer ids
+ (list) of buffer ids
get_client_by_id({client_id}) *vim.lsp.get_client_by_id()*
Gets a client by id, or nil if the id is invalid. The returned client may
@@ -1372,8 +1372,8 @@ apply_text_document_edit({text_document_edit}, {index}, {offset_encoding})
document.
Parameters: ~
- • {text_document_edit} table: a `TextDocumentEdit` object
- • {index} number: Optional index of the edit, if from a
+ • {text_document_edit} (table) a `TextDocumentEdit` object
+ • {index} (number) Optional index of the edit, if from a
list of edits (or nil, if not from a list)
See also: ~
@@ -1463,7 +1463,7 @@ convert_signature_help_to_markdown_lines({signature_help}, {ft}, {triggers})
server. used to better determine parameter offsets
Return: ~
- list of lines of converted markdown.
+ (list) of lines of converted markdown.
See also: ~
https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_signatureHelp
@@ -1485,7 +1485,7 @@ get_effective_tabstop({bufnr}) *vim.lsp.util.get_effective_tabstop()*
Returns indentation size.
Parameters: ~
- • {bufnr} (number|nil): Buffer handle, defaults to current
+ • {bufnr} (number|nil) Buffer handle, defaults to current
Return: ~
(number) indentation size
@@ -1589,7 +1589,7 @@ make_position_params({window}, {offset_encoding})
cursor position.
Parameters: ~
- • {window} number|nil: window handle or 0 for current,
+ • {window} (number|nil) window handle or 0 for current,
defaults to current
• {offset_encoding} (string) utf-8|utf-16|utf-32|nil defaults to
`offset_encoding` of first client of buffer of
@@ -1609,7 +1609,7 @@ make_range_params({window}, {offset_encoding})
`textDocument/rangeFormatting`.
Parameters: ~
- • {window} number|nil: window handle or 0 for current,
+ • {window} (number|nil) window handle or 0 for current,
defaults to current
• {offset_encoding} "utf-8"|"utf-16"|"utf-32"|nil defaults to
`offset_encoding` of first client of buffer of
@@ -1624,7 +1624,7 @@ make_text_document_params({bufnr})
Creates a `TextDocumentIdentifier` object for the current buffer.
Parameters: ~
- • {bufnr} number|nil: Buffer handle, defaults to current
+ • {bufnr} (number|nil) Buffer handle, defaults to current
Return: ~
`TextDocumentIdentifier`
@@ -1854,7 +1854,7 @@ notify({method}, {params}) *vim.lsp.rpc.notify()*
Parameters: ~
• {method} (string) The invoked LSP method
- • {params} (table|nil): Parameters for the invoked LSP method
+ • {params} (table|nil) Parameters for the invoked LSP method
Return: ~
(bool) `true` if notification could be sent, `false` if not
diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt
index 8e2270bc58..801664a670 100644
--- a/runtime/doc/lua.txt
+++ b/runtime/doc/lua.txt
@@ -1482,7 +1482,7 @@ on_key({fn}, {ns_id}) *vim.on_key()*
{fn} will receive the keys after mappings have been evaluated
Parameters: ~
- • {fn} function: Callback function. It should take one string
+ • {fn} (function) Callback function. It should take one string
argument. On each key press, Nvim passes the key char to
fn(). |i_CTRL-V| If {fn} is nil, it removes the callback for
the associated {ns_id}
@@ -1665,8 +1665,8 @@ list_extend({dst}, {src}, {start}, {finish}) *vim.list_extend()*
Parameters: ~
• {dst} (table) List which will be modified and appended to
• {src} (table) List from which values will be inserted
- • {start} (number) Start index on src. Defaults to 1
- • {finish} (number) Final index on src. Defaults to `#src`
+ • {start} (number|nil) Start index on src. Defaults to 1
+ • {finish} (number|nil) Final index on src. Defaults to `#src`
Return: ~
(table) dst
@@ -1679,12 +1679,12 @@ list_slice({list}, {start}, {finish}) *vim.list_slice()*
(inclusive)
Parameters: ~
- • {list} (table) Table
+ • {list} (list) Table
• {start} (number) Start range of slice
• {finish} (number) End range of slice
Return: ~
- (table) Copy of table sliced from start to finish (inclusive)
+ (list) Copy of table sliced from start to finish (inclusive)
pesc({s}) *vim.pesc()*
Escapes magic chars in |lua-patterns|.
@@ -1717,14 +1717,14 @@ split({s}, {sep}, {kwargs}) *vim.split()*
Parameters: ~
• {s} (string) String to split
• {sep} (string) Separator or pattern
- • {kwargs} split_kwargs Keyword arguments:
+ • {kwargs} (table|nil) Keyword arguments:
• plain: (boolean) If `true` use `sep` literally (passed to
string.find)
• trimempty: (boolean) If `true` remove empty items from the
front and back of the list
Return: ~
- (table) List of split components
+ string[] List of split components
startswith({s}, {prefix}) *vim.startswith()*
Tests if `s` starts with `prefix`.
@@ -1813,7 +1813,7 @@ tbl_filter({func}, {t}) *vim.tbl_filter()*
Filter a table using a predicate function
Parameters: ~
- • {func} function|table Function or callable table
+ • {func} (function) Function
• {t} (table) Table
Return: ~
@@ -1883,7 +1883,7 @@ tbl_keys({t}) *vim.tbl_keys()*
• {t} (table) Table
Return: ~
- (table) List of keys
+ (list) List of keys
See also: ~
From https://github.com/premake/premake-core/blob/master/src/base/table.lua
@@ -1892,7 +1892,7 @@ tbl_map({func}, {t}) *vim.tbl_map()*
Apply a function to all values of a table.
Parameters: ~
- • {func} function|table Function or callable table
+ • {func} (function) Function
• {t} (table) Table
Return: ~
@@ -1906,7 +1906,7 @@ tbl_values({t}) *vim.tbl_values()*
• {t} (table) Table
Return: ~
- (table) List of values
+ (list) List of values
trim({s}) *vim.trim()*
Trim whitespace (Lua pattern "%s") from both sides of a string.