aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc
diff options
context:
space:
mode:
authorRaphael <glepnir@neovim.pro>2023-07-10 19:38:15 +0800
committerGitHub <noreply@github.com>2023-07-10 04:38:15 -0700
commit766f4978d6cb146511cf0b676c01e5327db46647 (patch)
tree84fddf19619077a9e8fcf8bab33dbedbe08d0fad /runtime/doc
parentfbeef0d4ef1aadc4e50b9f33946cf4dca8ca6b62 (diff)
downloadrneovim-766f4978d6cb146511cf0b676c01e5327db46647.tar.gz
rneovim-766f4978d6cb146511cf0b676c01e5327db46647.tar.bz2
rneovim-766f4978d6cb146511cf0b676c01e5327db46647.zip
fix(lint): lint warnings #24226
Diffstat (limited to 'runtime/doc')
-rw-r--r--runtime/doc/lsp.txt17
-rw-r--r--runtime/doc/lua.txt6
2 files changed, 11 insertions, 12 deletions
diff --git a/runtime/doc/lsp.txt b/runtime/doc/lsp.txt
index 7bec93de89..4bafb622a6 100644
--- a/runtime/doc/lsp.txt
+++ b/runtime/doc/lsp.txt
@@ -663,7 +663,7 @@ buf_request_all({bufnr}, {method}, {params}, {handler})
Server results are passed as a `client_id:result` map.
Return: ~
- fun() cancel Function that cancels all requests.
+ (function) cancel Function that cancels all requests.
*vim.lsp.buf_request_sync()*
buf_request_sync({bufnr}, {method}, {params}, {timeout_ms})
@@ -802,7 +802,7 @@ get_client_by_id({client_id}) *vim.lsp.get_client_by_id()*
• {client_id} (integer) client id
Return: ~
- |vim.lsp.client| object, or nil
+ (nil|lsp.Client) client rpc object
get_log_path() *vim.lsp.get_log_path()*
Gets the path of the logfile used by the LSP client.
@@ -825,7 +825,7 @@ omnifunc({findstart}, {base}) *vim.lsp.omnifunc()*
• {base} (integer) findstart=0, text to match against
Return: ~
- (integer) Decided by {findstart}:
+ integer|table Decided by {findstart}:
• findstart=0: column where the completion starts, or -2 or -3
• findstart=1: list of matches (actually just calls |complete()|)
@@ -1116,7 +1116,7 @@ completion({context}) *vim.lsp.buf.completion()*
called in Insert mode.
Parameters: ~
- • {context} (context support not yet implemented) Additional
+ • {context} (table) (context support not yet implemented) Additional
information about the context in which a completion was
triggered (how it was triggered, and by which trigger
character, if applicable)
@@ -1296,7 +1296,7 @@ workspace_symbol({query}, {options}) *vim.lsp.buf.workspace_symbol()*
string means no filtering is done.
Parameters: ~
- • {query} (string, optional)
+ • {query} (string|nil) optional
• {options} (table|nil) additional options
• on_list: (function) handler for list results. See
|lsp-on-list-handler|
@@ -2040,7 +2040,7 @@ notify({method}, {params}) *vim.lsp.rpc.notify()*
• {params} (table|nil) Parameters for the invoked LSP method
Return: ~
- (bool) `true` if notification could be sent, `false` if not
+ (boolean) `true` if notification could be sent, `false` if not
*vim.lsp.rpc.request()*
request({method}, {params}, {callback}, {notify_reply_callback})
@@ -2092,9 +2092,8 @@ start({cmd}, {cmd_args}, {dispatchers}, {extra_spawn_params})
• {env} (table) Additional environment variables
for LSP server process
- Return (multiple): ~
- Client RPC object.
- Methods:
+ Return: ~
+ (table|nil) Client RPC object, with these methods:
• `notify()` |vim.lsp.rpc.notify()|
• `request()` |vim.lsp.rpc.request()|
• `is_closing()` returns a boolean indicating if the RPC is closing.
diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt
index 9e4815bea5..ae3c248d64 100644
--- a/runtime/doc/lua.txt
+++ b/runtime/doc/lua.txt
@@ -1518,7 +1518,7 @@ paste({lines}, {phase}) *vim.paste()*
• 3: ends the paste (exactly once)
Return: ~
- (boolean) # false if client should cancel the paste.
+ (boolean) result false if client should cancel the paste.
See also: ~
• |paste| @alias paste_phase -1 | 1 | 2 | 3
@@ -2637,7 +2637,7 @@ basename({file}) *vim.fs.basename()*
• {file} (string) File or directory
Return: ~
- (string) Basename of {file}
+ (string|nil) Basename of {file}
dir({path}, {opts}) *vim.fs.dir()*
Return an iterator over the files and directories located in {path}
@@ -2664,7 +2664,7 @@ dirname({file}) *vim.fs.dirname()*
• {file} (string) File or directory
Return: ~
- (string) Parent directory of {file}
+ (string|nil) Parent directory of {file}
find({names}, {opts}) *vim.fs.find()*
Find files or directories in the given path.