GitHub/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim synced 2025-07-16 09:11:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(meta): do not use hyphens in param names

Browse Source 
Fixes #30882
This commit is contained in:
Lewis Russell
2024-10-21 11:36:02 +01:00
committed by Lewis Russell
parent 3572319b4c
commit c8e47f6480
3 changed files with 14 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
runtime/doc/builtin.txt generated
View File

@ -269,16 +269,16 @@ assert_equal({expected}, {actual} [, {msg}]) *assert_equal()*
Return: ~ Return: ~
(`0|1`) (`0|1`)
assert_equalfile({fname-one}, {fname-two}) *assert_equalfile()* assert_equalfile({fname_one}, {fname_two}) *assert_equalfile()*
When the files {fname-one} and {fname-two} do not contain When the files {fname_one} and {fname_two} do not contain
exactly the same text an error message is added to |v:errors|. exactly the same text an error message is added to |v:errors|.
Also see |assert-return|. Also see |assert-return|.
When {fname-one} or {fname-two} does not exist the error will When {fname_one} or {fname_two} does not exist the error will
mention that. mention that.
Parameters: ~ Parameters: ~
• {fname-one} (`string`) • {fname_one} (`string`)
• {fname-two} (`string`) • {fname_two} (`string`)
Return: ~ Return: ~
(`0|1`) (`0|1`)

10
runtime/lua/vim/_meta/vimfn.lua generated
View File

@ -221,16 +221,16 @@ function vim.fn.assert_beeps(cmd) end
--- @return 0|1 --- @return 0|1
function vim.fn.assert_equal(expected, actual, msg) end function vim.fn.assert_equal(expected, actual, msg) end
--- When the files {fname-one} and {fname-two} do not contain --- When the files {fname_one} and {fname_two} do not contain
--- exactly the same text an error message is added to |v:errors|. --- exactly the same text an error message is added to |v:errors|.
--- Also see |assert-return|. --- Also see |assert-return|.
--- When {fname-one} or {fname-two} does not exist the error will --- When {fname_one} or {fname_two} does not exist the error will
--- mention that. --- mention that.
--- ---
--- @param fname-one string --- @param fname_one string
--- @param fname-two string --- @param fname_two string
--- @return 0|1 --- @return 0|1
function vim.fn.assert_equalfile(fname-one, fname-two) end function vim.fn.assert_equalfile(fname_one, fname_two) end
--- When v:exception does not contain the string {error} an error --- When v:exception does not contain the string {error} an error
--- message is added to |v:errors|. Also see |assert-return|. --- message is added to |v:errors|. Also see |assert-return|.

8
src/nvim/eval.lua
View File

@ -326,17 +326,17 @@ M.funcs = {
args = { 2, 3 }, args = { 2, 3 },
base = 1, base = 1,
desc = [=[ desc = [=[
When the files {fname-one} and {fname-two} do not contain When the files {fname_one} and {fname_two} do not contain
exactly the same text an error message is added to |v:errors|. exactly the same text an error message is added to |v:errors|.
Also see |assert-return|. Also see |assert-return|.
When {fname-one} or {fname-two} does not exist the error will When {fname_one} or {fname_two} does not exist the error will
mention that. mention that.
]=], ]=],
name = 'assert_equalfile', name = 'assert_equalfile',
params = { { 'fname-one', 'string' }, { 'fname-two', 'string' } }, params = { { 'fname_one', 'string' }, { 'fname_two', 'string' } },
returns = '0|1', returns = '0|1',
signature = 'assert_equalfile({fname-one}, {fname-two})', signature = 'assert_equalfile({fname_one}, {fname_two})',
}, },
assert_exception = { assert_exception = {
args = { 1, 2 }, args = { 1, 2 },