diff options
| author | notomo <notomo.motono@gmail.com> | 2023-01-04 20:48:41 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-01-04 11:48:41 +0000 |
| commit | e35b9020b16985eee26e942f9a3f6b045bc3809b (patch) | |
| tree | 0a685e4fccb55380017e059243db0570a83954cb /runtime/doc | |
| parent | ef18c9f9b05caf1f39ed32762f53802e378f143b (diff) | |
| download | rneovim-e35b9020b16985eee26e942f9a3f6b045bc3809b.tar.gz rneovim-e35b9020b16985eee26e942f9a3f6b045bc3809b.tar.bz2 rneovim-e35b9020b16985eee26e942f9a3f6b045bc3809b.zip | |
docs(lua): adjust some type annotations
Diffstat (limited to 'runtime/doc')
| -rw-r--r-- | runtime/doc/lsp.txt | 10 | ||||
| -rw-r--r-- | runtime/doc/lua.txt | 4 |
2 files changed, 7 insertions, 7 deletions
diff --git a/runtime/doc/lsp.txt b/runtime/doc/lsp.txt index 705d7675e5..cf82cbf204 100644 --- a/runtime/doc/lsp.txt +++ b/runtime/doc/lsp.txt @@ -974,7 +974,7 @@ stop_client({client_id}, {force}) *vim.lsp.stop_client()* Parameters: ~ • {client_id} number|table id or |vim.lsp.client| object, or list thereof - • {force} (boolean) (optional) shutdown forcefully + • {force} (boolean|nil) shutdown forcefully tagfunc({...}) *vim.lsp.tagfunc()* Provides an interface between the built-in client and 'tagfunc'. @@ -1174,7 +1174,7 @@ references({context}, {options}) *vim.lsp.buf.references()* window. Parameters: ~ - • {context} (table) Context for the request + • {context} (table|nil) Context for the request • {options} (table|nil) additional options • on_list: (function) handler for list results. See |lsp-on-list-handler| @@ -1566,7 +1566,7 @@ jump_to_location({location}, {offset_encoding}, {reuse_win}) Parameters: ~ • {location} (table) (`Location`|`LocationLink`) • {offset_encoding} "utf-8" | "utf-16" | "utf-32" - • {reuse_win} (boolean) Jump to existing window if buffer is + • {reuse_win} (boolean|nil) Jump to existing window if buffer is already open. Return: ~ @@ -1657,7 +1657,7 @@ make_position_params({window}, {offset_encoding}) Parameters: ~ • {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} (string|nil) utf-8|utf-16|utf-32|nil defaults to `offset_encoding` of first client of buffer of `window` @@ -1788,7 +1788,7 @@ show_document({location}, {offset_encoding}, {opts}) Parameters: ~ • {location} (table) (`Location`|`LocationLink`) • {offset_encoding} "utf-8" | "utf-16" | "utf-32" - • {opts} (table) options + • {opts} (table|nil) options • reuse_win (boolean) Jump to existing window if buffer is already open. • focus (boolean) Whether to focus/jump to location diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt index 074cb863f0..9cb189b927 100644 --- a/runtime/doc/lua.txt +++ b/runtime/doc/lua.txt @@ -1678,8 +1678,8 @@ list_slice({list}, {start}, {finish}) *vim.list_slice()* Parameters: ~ • {list} (list) Table - • {start} (number) Start range of slice - • {finish} (number) End range of slice + • {start} (number|nil) Start range of slice + • {finish} (number|nil) End range of slice Return: ~ (list) Copy of table sliced from start to finish (inclusive) |