diff options
| author | Mathias Fußenegger <mfussenegger@users.noreply.github.com> | 2021-11-18 21:12:21 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-11-18 21:12:21 +0100 |
| commit | d249e18bbf3454088eddf400b13b353b3ff6d91c (patch) | |
| tree | 89f8f2851e575fe85adfd5bbe99ca77c23afe7fb /runtime/doc/lua.txt | |
| parent | 722647dd8caf145517d45adae2fd62090b0847ea (diff) | |
| download | rneovim-d249e18bbf3454088eddf400b13b353b3ff6d91c.tar.gz rneovim-d249e18bbf3454088eddf400b13b353b3ff6d91c.tar.bz2 rneovim-d249e18bbf3454088eddf400b13b353b3ff6d91c.zip | |
fix(uri): use valid EmmyLua annotations (#16359)
See:
- https://emmylua.github.io/annotations/param.html
- https://emmylua.github.io/annotations/return.html
Diffstat (limited to 'runtime/doc/lua.txt')
| -rw-r--r-- | runtime/doc/lua.txt | 22 |
1 files changed, 10 insertions, 12 deletions
diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt index ef2d87949d..906da31d3a 100644 --- a/runtime/doc/lua.txt +++ b/runtime/doc/lua.txt @@ -1658,40 +1658,38 @@ uri_from_bufnr({bufnr}) *vim.uri_from_bufnr()* Get a URI from a bufnr Parameters: ~ - {bufnr} (number): Buffer number + {bufnr} number Return: ~ - URI + string URI uri_from_fname({path}) *vim.uri_from_fname()* Get a URI from a file path. Parameters: ~ - {path} (string): Path to file + {path} string Path to file Return: ~ - URI + string URI uri_to_bufnr({uri}) *vim.uri_to_bufnr()* - Return or create a buffer for a uri. + Get the buffer for a uri. Creates a new unloaded buffer if no + buffer for the uri already exists. Parameters: ~ - {uri} (string): The URI + {uri} string Return: ~ - bufnr. - - Note: - Creates buffer but does not load it + number bufnr uri_to_fname({uri}) *vim.uri_to_fname()* Get a filename from a URI Parameters: ~ - {uri} (string): The URI + {uri} string Return: ~ - Filename + string filename or unchanged URI for non-file URIs ============================================================================== |