diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2024-05-15 15:44:10 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-05-15 15:44:10 -0700 |
| commit | 7c13d1a4a836effd436f8bbcdf1d03113f4c48c6 (patch) | |
| tree | 87d31c2bac12322cf5a54803110d66ff4be61f17 /runtime/lua/vim/_meta | |
| parent | 007adde1994da7f25eaa0e6a4f402587afbc508d (diff) | |
| parent | 4399c4932d7b0565932a667e051f6861b8293157 (diff) | |
| download | rneovim-7c13d1a4a836effd436f8bbcdf1d03113f4c48c6.tar.gz rneovim-7c13d1a4a836effd436f8bbcdf1d03113f4c48c6.tar.bz2 rneovim-7c13d1a4a836effd436f8bbcdf1d03113f4c48c6.zip | |
Merge #28747 from justinmk/doc
Diffstat (limited to 'runtime/lua/vim/_meta')
| -rw-r--r-- | runtime/lua/vim/_meta/lpeg.lua | 7 | ||||
| -rw-r--r-- | runtime/lua/vim/_meta/re.lua | 8 |
2 files changed, 7 insertions, 8 deletions
diff --git a/runtime/lua/vim/_meta/lpeg.lua b/runtime/lua/vim/_meta/lpeg.lua index 1ce40f3340..73b3375c82 100644 --- a/runtime/lua/vim/_meta/lpeg.lua +++ b/runtime/lua/vim/_meta/lpeg.lua @@ -6,11 +6,10 @@ error('Cannot require a meta file') -- with types being renamed to include the vim namespace and with some descriptions made less verbose. --- @brief <pre>help ---- LPeg is a pattern-matching library for Lua, based on ---- Parsing Expression Grammars (https://bford.info/packrat/) (PEGs). +--- LPeg is a pattern-matching library for Lua, based on Parsing Expression +--- Grammars (PEGs). https://bford.info/packrat/ --- ---- *lua-lpeg* ---- *vim.lpeg.Pattern* +--- *lua-lpeg* *vim.lpeg.Pattern* --- The LPeg library for parsing expression grammars is included as `vim.lpeg` --- (https://www.inf.puc-rio.br/~roberto/lpeg/). --- diff --git a/runtime/lua/vim/_meta/re.lua b/runtime/lua/vim/_meta/re.lua index 9721e6f8c8..d16751fbbf 100644 --- a/runtime/lua/vim/_meta/re.lua +++ b/runtime/lua/vim/_meta/re.lua @@ -8,11 +8,11 @@ error('Cannot require a meta file') -- See 'lpeg.html' for license --- @brief ---- The `vim.re` module provides a conventional regex-like syntax for pattern usage ---- within LPeg |vim.lpeg|. +--- The `vim.re` module provides a conventional regex-like syntax for pattern usage within LPeg +--- |vim.lpeg|. (Unrelated to |vim.regex| which provides Vim |regexp| from Lua.) --- ---- See https://www.inf.puc-rio.br/~roberto/lpeg/re.html for the original ---- documentation including regex syntax and more concrete examples. +--- See https://www.inf.puc-rio.br/~roberto/lpeg/re.html for the original documentation including +--- regex syntax and examples. --- Compiles the given {string} and returns an equivalent LPeg pattern. The given string may define --- either an expression or a grammar. The optional {defs} table provides extra Lua values to be used |