aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc
diff options
context:
space:
mode:
authorEvgeni Chasnovski <evgeni.chasnovski@gmail.com>2024-09-22 13:51:22 +0300
committerGitHub <noreply@github.com>2024-09-22 03:51:22 -0700
commit29bceb4f758097cc6b66726f1dcd3967ad170e35 (patch)
treefbf5f0ca947de69723a218eef2a595f19cba3198 /runtime/doc
parente697c1b43dfbeab132fee4149157f7abd08c51a0 (diff)
downloadrneovim-29bceb4f758097cc6b66726f1dcd3967ad170e35.tar.gz
rneovim-29bceb4f758097cc6b66726f1dcd3967ad170e35.tar.bz2
rneovim-29bceb4f758097cc6b66726f1dcd3967ad170e35.zip
docs(api): nvim_get_runtime_file preserves 'runtimepath' order #30454
Diffstat (limited to 'runtime/doc')
-rw-r--r--runtime/doc/api.txt6
1 files changed, 3 insertions, 3 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt
index 45c6168e3d..6c9471b169 100644
--- a/runtime/doc/api.txt
+++ b/runtime/doc/api.txt
@@ -954,11 +954,11 @@ nvim_get_proc_children({pid}) *nvim_get_proc_children()*
Array of child process ids, empty if process not found.
nvim_get_runtime_file({name}, {all}) *nvim_get_runtime_file()*
- 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.