docs(api): nvim_get_runtime_file preserves 'runtimepath' order #30454

This commit is contained in:
Evgeni Chasnovski
2024-09-22 13:51:22 +03:00
committed by GitHub
parent e697c1b43d
commit 29bceb4f75
4 changed files with 18 additions and 8 deletions

View File

@@ -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.