diff options
| author | Gregory Anders <greg@gpanders.com> | 2021-08-22 14:55:28 -0600 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-08-22 13:55:28 -0700 |
| commit | c2a211b8e3e00dfae594ccbd9a107aef85a9919c (patch) | |
| tree | 727257465343243052b04f4405bdaceda2f05be3 /test/functional/helpers.lua | |
| parent | 649dbb3b15949aee9d9e25cd39cca1e3e3a4ee45 (diff) | |
| download | rneovim-c2a211b8e3e00dfae594ccbd9a107aef85a9919c.tar.gz rneovim-c2a211b8e3e00dfae594ccbd9a107aef85a9919c.tar.bz2 rneovim-c2a211b8e3e00dfae594ccbd9a107aef85a9919c.zip | |
docs: make Lua docstrings consistent #15255
The official developer documentation in in :h dev-lua-doc specifies to
use "--@" for special/magic tokens. However, this format is not
consistent with EmmyLua notation (used by some Lua language servers) nor
with the C version of the magic docstring tokens which use three comment
characters.
Further, the code base is currently split between usage of "--@",
"---@", and "--- @". In an effort to remain consistent, change all Lua
magic tokens to use "---@" and update the developer documentation
accordingly.
Diffstat (limited to 'test/functional/helpers.lua')
| -rw-r--r-- | test/functional/helpers.lua | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/test/functional/helpers.lua b/test/functional/helpers.lua index 5974e8897f..92d802d62d 100644 --- a/test/functional/helpers.lua +++ b/test/functional/helpers.lua @@ -422,7 +422,7 @@ end -- Builds an argument list for use in clear(). -- ---@see clear() for parameters. +---@see clear() for parameters. function module.new_argv(...) local args = {unpack(module.nvim_argv)} table.insert(args, '--headless') @@ -573,7 +573,7 @@ function module.buf_lines(bufnr) return module.exec_lua("return vim.api.nvim_buf_get_lines((...), 0, -1, false)", bufnr) end ---@see buf_lines() +---@see buf_lines() function module.curbuf_contents() module.poke_eventloop() -- Before inspecting the buffer, do whatever. return table.concat(module.curbuf('get_lines', 0, -1, true), '\n') |