diff options
author | TJ DeVries <devries.timothyj@gmail.com> | 2020-09-14 09:12:17 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-09-14 09:12:17 -0400 |
commit | 4a2618c8174eabb59a713cce6ae94a5ca592aeb3 (patch) | |
tree | 2594035b38c80b5d2213a779a82dc72395627293 /runtime/doc | |
parent | 20f7b94284a1b7d903bfa81cb2120b55058fbe7f (diff) | |
download | rneovim-4a2618c8174eabb59a713cce6ae94a5ca592aeb3.tar.gz rneovim-4a2618c8174eabb59a713cce6ae94a5ca592aeb3.tar.bz2 rneovim-4a2618c8174eabb59a713cce6ae94a5ca592aeb3.zip |
doc: Add docs for uri functions (#12887)
Diffstat (limited to 'runtime/doc')
-rw-r--r-- | runtime/doc/lua.txt | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt index a60153d65f..477e70a9ae 100644 --- a/runtime/doc/lua.txt +++ b/runtime/doc/lua.txt @@ -1567,4 +1567,46 @@ validate({opt}) *vim.validate()* • msg: (optional) error string if validation fails + +============================================================================== +Lua module: uri *lua-uri* + +uri_from_bufnr({bufnr}) *vim.uri_from_bufnr()* + Get a URI from a bufnr + + Parameters: ~ + {bufnr} (number): Buffer number + + Return: ~ + URI + +uri_from_fname({path}) *vim.uri_from_fname()* + Get a URI from a file path. + + Parameters: ~ + {path} (string): Path to file + + Return: ~ + URI + +uri_to_bufnr({uri}) *vim.uri_to_bufnr()* + Return or create a buffer for a uri. + + Parameters: ~ + {uri} (string): The URI + + Return: ~ + bufnr. + Note: + Creates buffer but does not load it + +uri_to_fname({uri}) *vim.uri_to_fname()* + Get a filename from a URI + + Parameters: ~ + {uri} (string): The URI + + Return: ~ + Filename + vim:tw=78:ts=8:ft=help:norl: |