diff options
| author | Evgeni Chasnovski <evgeni.chasnovski@gmail.com> | 2024-09-22 13:51:22 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-09-22 03:51:22 -0700 |
| commit | 29bceb4f758097cc6b66726f1dcd3967ad170e35 (patch) | |
| tree | fbf5f0ca947de69723a218eef2a595f19cba3198 /runtime/lua/vim/_meta/api.lua | |
| parent | e697c1b43dfbeab132fee4149157f7abd08c51a0 (diff) | |
| download | rneovim-29bceb4f758097cc6b66726f1dcd3967ad170e35.tar.gz rneovim-29bceb4f758097cc6b66726f1dcd3967ad170e35.tar.bz2 rneovim-29bceb4f758097cc6b66726f1dcd3967ad170e35.zip | |
docs(api): nvim_get_runtime_file preserves 'runtimepath' order #30454
Diffstat (limited to 'runtime/lua/vim/_meta/api.lua')
| -rw-r--r-- | runtime/lua/vim/_meta/api.lua | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua index 871521db43..1d8354f6f7 100644 --- a/runtime/lua/vim/_meta/api.lua +++ b/runtime/lua/vim/_meta/api.lua @@ -1454,11 +1454,11 @@ function vim.api.nvim_get_proc(pid) end --- @return any[] function vim.api.nvim_get_proc_children(pid) end ---- Find files in runtime directories +--- Finds files in runtime directories, in 'runtimepath' order. --- --- "name" can contain wildcards. For example ---- nvim_get_runtime_file("colors/*.vim", true) will return all color scheme ---- files. Always use forward slashes (/) in the search pattern for +--- `nvim_get_runtime_file("colors/*.{vim,lua}", true)` will return all color +--- scheme files. Always use forward slashes (/) in the search pattern for --- subdirectories regardless of platform. --- --- It is not an error to not find any files. An empty array is returned then. |