docs: luaref cleanup #24541

- drop "luaref-" prefix in favor of "lua-" or nothing, where possible.
- remove redundant "luaref--lang…" and "luaref-api…" tags.
This commit is contained in:
Justin M. Keyes
2023-08-03 08:35:10 -07:00
committed by GitHub
parent 4d859d00d1
commit b034378cf5
8 changed files with 270 additions and 280 deletions

View File

@@ -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