diff options
author | Justin M. Keyes <justinkz@gmail.com> | 2023-06-22 03:44:51 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-06-22 03:44:51 -0700 |
commit | 4e6356559c8cd44dbcaa765d1f39e176064526ec (patch) | |
tree | 84354e7d3c5a49b7edbc314da2e2b834d275d42c /runtime/doc/lua.txt | |
parent | f4f1ce1d167c557e54153f74cf0f55245b8fd414 (diff) | |
download | rneovim-4e6356559c8cd44dbcaa765d1f39e176064526ec.tar.gz rneovim-4e6356559c8cd44dbcaa765d1f39e176064526ec.tar.bz2 rneovim-4e6356559c8cd44dbcaa765d1f39e176064526ec.zip |
test: spellcheck :help (vimdoc) files #24109
Enforce consistent terminology (defined in
`gen_help_html.lua:spell_dict`) for common misspellings.
This does not spellcheck English in general (perhaps a future TODO,
though it may be noisy).
Diffstat (limited to 'runtime/doc/lua.txt')
-rw-r--r-- | runtime/doc/lua.txt | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt index 80ef2e358c..c3eaf1ae39 100644 --- a/runtime/doc/lua.txt +++ b/runtime/doc/lua.txt @@ -34,7 +34,7 @@ Nvim ever ships with Lua 5.4+, a Lua 5.1 compatibility shim will be provided so that old plugins continue to work transparently. *lua-luajit* -Neovim is built with luajit on platforms which support it, which provides +Nvim is built with luajit on platforms which support it, which provides extra functionality. Lua code in |init.lua| and plugins can assume its presence on installations on common platforms. For maximum compatibility with less common platforms, availability can be checked using the `jit` global variable: >lua @@ -46,7 +46,7 @@ common platforms, availability can be checked using the `jit` global variable: > < *lua-bit* In particular, the luajit "bit" extension module is _always_ available. -A fallback implementation is included when nvim is built with PUC lua 5.1, +A fallback implementation is included when nvim is built with PUC Lua 5.1, and will be transparently used when `require("bit")` is invoked. ============================================================================== @@ -549,7 +549,7 @@ Multithreading *lua-loop-threading* Plugins can perform work in separate (os-level) threads using the threading APIs in luv, for instance `vim.uv.new_thread`. Note that every thread -gets its own separate lua interpreter state, with no access to lua globals +gets its own separate Lua interpreter state, with no access to Lua globals in the main thread. Neither can the state of the editor (buffers, windows, etc) be directly accessed from threads. @@ -557,10 +557,10 @@ A subset of the `vim.*` API is available in threads. This includes: - `vim.uv` with a separate event loop per thread. - `vim.mpack` and `vim.json` (useful for serializing messages between threads) -- `require` in threads can use lua packages from the global |package.path| +- `require` in threads can use Lua packages from the global |package.path| - `print()` and `vim.inspect` - `vim.diff` -- most utility functions in `vim.*` for working with pure lua values +- most utility functions in `vim.*` for working with pure Lua values like `vim.split`, `vim.tbl_*`, `vim.list_*`, and so on. - `vim.is_thread()` returns true from a non-main thread. @@ -624,7 +624,7 @@ vim.highlight.priorities *vim.highlight.priorities* ------------------------------------------------------------------------------ VIM.REGEX *lua-regex* -Vim regexes can be used directly from lua. Currently they only allow +Vim regexes can be used directly from Lua. Currently they only allow matching within a single line. vim.regex({re}) *vim.regex()* @@ -933,8 +933,8 @@ vim.wait({time} [, {callback}, {interval}, {fast_only}]) *vim.wait()* vim.ui_attach({ns}, {options}, {callback}) *vim.ui_attach()* Attach to ui events, similar to |nvim_ui_attach()| but receive events - as lua callback. Can be used to implement screen elements like - popupmenu or message handling in lua. + as Lua callback. Can be used to implement screen elements like + popupmenu or message handling in Lua. {options} should be a dictionary-like table, where `ext_...` options should be set to true to receive events for the respective external element. @@ -1262,7 +1262,7 @@ In any of the above examples, to replicate the behavior |:setlocal|, use *vim.opt:get()* Option:get() - Returns a lua-representation of the option. Boolean, number and string + Returns a Lua-representation of the option. Boolean, number and string values will be returned in exactly the same fashion. For values that are comma-separated lists, an array will be returned with @@ -1435,10 +1435,10 @@ keycode({str}) *vim.keycode()* • |nvim_replace_termcodes()| lua_omnifunc({find_start}, {_}) *vim.lua_omnifunc()* - Omnifunc for completing lua values from the runtime lua interpreter, + Omnifunc for completing Lua values from the runtime Lua interpreter, similar to the builtin completion for the `:lua` command. - Activate using `set omnifunc=v:lua.vim.lua_omnifunc` in a lua buffer. + Activate using `set omnifunc=v:lua.vim.lua_omnifunc` in a Lua buffer. notify({msg}, {level}, {opts}) *vim.notify()* Display a notification to the user. @@ -2230,17 +2230,17 @@ Lua module: loader *lua-loader* disable() *vim.loader.disable()* Disables the experimental Lua module loader: • removes the loaders - • adds the default Neovim loader + • adds the default Nvim loader enable() *vim.loader.enable()* Enables the experimental Lua module loader: • overrides loadfile - • adds the lua loader using the byte-compilation cache + • adds the Lua loader using the byte-compilation cache • adds the libs loader - • removes the default Neovim loader + • removes the default Nvim loader find({modname}, {opts}) *vim.loader.find()* - Finds lua modules for the given module name. + Finds Lua modules for the given module name. Parameters: ~ • {modname} (string) Module name, or `"*"` to find the top-level |