diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2023-08-03 08:35:10 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-08-03 08:35:10 -0700 |
| commit | b034378cf58bea18ea1bdb4d63692a1336b5752b (patch) | |
| tree | b5e2d1a9015c29fd505b8cab53201ff8857792ce /runtime/lua/vim | |
| parent | 4d859d00d13893815b6072a7bf2022dd89d5e3f8 (diff) | |
| download | rneovim-b034378cf58bea18ea1bdb4d63692a1336b5752b.tar.gz rneovim-b034378cf58bea18ea1bdb4d63692a1336b5752b.tar.bz2 rneovim-b034378cf58bea18ea1bdb4d63692a1336b5752b.zip | |
docs: luaref cleanup #24541
- drop "luaref-" prefix in favor of "lua-" or nothing, where possible.
- remove redundant "luaref--lang…" and "luaref-api…" tags.
Diffstat (limited to 'runtime/lua/vim')
| -rw-r--r-- | runtime/lua/vim/_meta/regex.lua | 6 | ||||
| -rw-r--r-- | runtime/lua/vim/shared.lua | 4 |
2 files changed, 5 insertions, 5 deletions
diff --git a/runtime/lua/vim/_meta/regex.lua b/runtime/lua/vim/_meta/regex.lua index 4bca67797a..ab4f46d43f 100644 --- a/runtime/lua/vim/_meta/regex.lua +++ b/runtime/lua/vim/_meta/regex.lua @@ -18,9 +18,9 @@ function vim.regex(re) end local regex = {} -- luacheck: no unused --- Match the string against the regex. If the string should match the regex ---- precisely, surround the regex with `^` and `$`. If the was a match, the ---- byte indices for the beginning and end of the match is returned. When ---- there is no match, `nil` is returned. As any integer is truth-y, +--- precisely, surround the regex with `^` and `$`. If there was a match, the +--- byte indices for the beginning and end of the match are returned. When +--- there is no match, `nil` is returned. Because any integer is "truthy", --- `regex:match()` can be directly used as a condition in an if-statement. --- @param str string function regex:match_str(str) end diff --git a/runtime/lua/vim/shared.lua b/runtime/lua/vim/shared.lua index 5ce5b200d3..32575a1cc9 100644 --- a/runtime/lua/vim/shared.lua +++ b/runtime/lua/vim/shared.lua @@ -80,7 +80,7 @@ end --- --- @see |string.gmatch()| --- @see |vim.split()| ---- @see |luaref-patterns| +--- @see |lua-patterns| --- @see https://www.lua.org/pil/20.2.html --- @see http://lua-users.org/wiki/StringLibraryTutorial --- @@ -660,7 +660,7 @@ end --- Trim whitespace (Lua pattern "%s") from both sides of a string. --- ----@see |luaref-patterns| +---@see |lua-patterns| ---@see https://www.lua.org/pil/20.2.html ---@param s string String to trim ---@return string String with whitespace removed from its beginning and end |