aboutsummaryrefslogtreecommitdiff
path: root/runtime
diff options
context:
space:
mode:
authordundargoc <gocdundar@gmail.com>2023-09-15 09:43:48 +0200
committerdundargoc <33953936+dundargoc@users.noreply.github.com>2023-10-10 19:20:32 +0200
commitc3d21ad1bccd9a2975be73b1115213fd884eada3 (patch)
tree8c7144e6ddc18a6cf9c097f5516b6f9b74221112 /runtime
parentfd39f5ce8c9bbda1b77ff6c03553148fadac5d57 (diff)
downloadrneovim-c3d21ad1bccd9a2975be73b1115213fd884eada3.tar.gz
rneovim-c3d21ad1bccd9a2975be73b1115213fd884eada3.tar.bz2
rneovim-c3d21ad1bccd9a2975be73b1115213fd884eada3.zip
docs: small fixes
Co-authored-by: Wansmer <wansmer@gmail.com> Co-authored-by: Andrew Voynov <andrewvoynov.b@gmail.com> Co-authored-by: David Moberg <david.moberg@mediatek.com>
Diffstat (limited to 'runtime')
-rw-r--r--runtime/doc/develop.txt6
-rw-r--r--runtime/doc/lua-guide.txt10
-rw-r--r--runtime/doc/remote_plugin.txt4
-rw-r--r--runtime/lua/vim/treesitter/_meta.lua1
4 files changed, 9 insertions, 12 deletions
diff --git a/runtime/doc/develop.txt b/runtime/doc/develop.txt
index c88b8a88c3..107915d017 100644
--- a/runtime/doc/develop.txt
+++ b/runtime/doc/develop.txt
@@ -232,11 +232,7 @@ Lua documentation lives in the source code, as docstrings on the function
definitions. The |lua-vim| :help is generated from the docstrings.
Docstring format:
-- Use LuaLS annotations (with minor adjustments, which will be explained
- below): https://luals.github.io/wiki/annotations/
-- Lines in the main description start with `--- `
-- Special tokens start with `--- @` followed by the token name: `--- @see`,
- `--- @param`, `--- @returns`. Note the space between `---` and `@`.
+- Use LuaCATS annotations: https://luals.github.io/wiki/annotations/
- Limited markdown is supported.
- List-items start with `-` (useful to nest or "indent")
- Use ``` for code samples.
diff --git a/runtime/doc/lua-guide.txt b/runtime/doc/lua-guide.txt
index e2fece916c..c15b1b0495 100644
--- a/runtime/doc/lua-guide.txt
+++ b/runtime/doc/lua-guide.txt
@@ -462,9 +462,9 @@ useful options:
vim.keymap.set('n', '<Leader>pl1', require('plugin').action,
{ desc = 'Execute action from plugin' })
<
-• `remap`: By default, all mappings are nonrecursive by default (i.e.,
- |vim.keymap.set()| behaves like |:noremap|). If the {rhs} is itself a mapping
- that should be executed, set `remap = true`: >lua
+• `remap`: By default, all mappings are nonrecursive (i.e., |vim.keymap.set()|
+ behaves like |:noremap|). If the {rhs} is itself a mapping that should be
+ executed, set `remap = true`: >lua
vim.keymap.set('n', '<Leader>ex1', '<cmd>echo "Example 1"<cr>')
-- add a shorter mapping
vim.keymap.set('n', 'e', '<Leader>ex1', { remap = true })
@@ -670,8 +670,8 @@ cover only the basics of this advanced topic.
------------------------------------------------------------------------------
Creating user commands *lua-guide-commands-create*
-User commands can be created through with |nvim_create_user_command()|. This
-function takes three mandatory arguments:
+User commands can be created via |nvim_create_user_command()|. This function
+takes three mandatory arguments:
• a string that is the name of the command (which must start with an uppercase
letter to distinguish it from builtin commands);
• a string containing Vim commands or a Lua function that is executed when the
diff --git a/runtime/doc/remote_plugin.txt b/runtime/doc/remote_plugin.txt
index ea35cf2b78..cfe4b08000 100644
--- a/runtime/doc/remote_plugin.txt
+++ b/runtime/doc/remote_plugin.txt
@@ -40,8 +40,8 @@ fast as possible, even if many plugins/hosts are installed.
The best way to learn about remote plugins is with an example, so let's see
what a Python plugin looks like. This plugin exports a command, a function, and
an autocmd. The plugin is called 'Limit', and all it does is limit the number
-of requests made to it. Here's the plugin source code:
->
+of requests made to it. Here's the plugin source code: >python
+
import pynvim
@pynvim.plugin
diff --git a/runtime/lua/vim/treesitter/_meta.lua b/runtime/lua/vim/treesitter/_meta.lua
index d01b7be3b0..cd8462bcb7 100644
--- a/runtime/lua/vim/treesitter/_meta.lua
+++ b/runtime/lua/vim/treesitter/_meta.lua
@@ -29,6 +29,7 @@
---@field sexpr fun(self: TSNode): string
---@field equal fun(self: TSNode, other: TSNode): boolean
---@field iter_children fun(self: TSNode): fun(): TSNode, string
+---@field field fun(self: TSNode, name: string): TSNode[]
local TSNode = {}
---@param query userdata