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 /runtime/lua/vim/F.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 'runtime/lua/vim/F.lua')
| -rw-r--r-- | runtime/lua/vim/F.lua | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/runtime/lua/vim/F.lua b/runtime/lua/vim/F.lua index 7925ff6e44..09467eb8c6 100644 --- a/runtime/lua/vim/F.lua +++ b/runtime/lua/vim/F.lua @@ -2,8 +2,8 @@ local F = {} --- Returns {a} if it is not nil, otherwise returns {b}. --- ---@param a ---@param b +---@param a +---@param b function F.if_nil(a, b) if a == nil then return b end return a |