aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLewis Russell <lewis6991@gmail.com>2024-10-21 11:36:02 +0100
committerLewis Russell <me@lewisr.dev>2024-10-21 12:09:33 +0100
commitc8e47f648052f8001d8a493cf7ca6c4867a36bc3 (patch)
treeb04134d30fd21fad10cb42d26e621465cbcd0a27
parent3572319b4cb1a4163624a5fe328886f1928dbc4a (diff)
downloadrneovim-c8e47f648052f8001d8a493cf7ca6c4867a36bc3.tar.gz
rneovim-c8e47f648052f8001d8a493cf7ca6c4867a36bc3.tar.bz2
rneovim-c8e47f648052f8001d8a493cf7ca6c4867a36bc3.zip
fix(meta): do not use hyphens in param names
Fixes #30882
-rw-r--r--runtime/doc/builtin.txt10
-rw-r--r--runtime/lua/vim/_meta/vimfn.lua10
-rw-r--r--src/nvim/eval.lua8
3 files changed, 14 insertions, 14 deletions
diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt
index 8567d6227c..dd7032aaab 100644
--- a/runtime/doc/builtin.txt
+++ b/runtime/doc/builtin.txt
@@ -269,16 +269,16 @@ assert_equal({expected}, {actual} [, {msg}]) *assert_equal()*
Return: ~
(`0|1`)
-assert_equalfile({fname-one}, {fname-two}) *assert_equalfile()*
- When the files {fname-one} and {fname-two} do not contain
+assert_equalfile({fname_one}, {fname_two}) *assert_equalfile()*
+ When the files {fname_one} and {fname_two} do not contain
exactly the same text an error message is added to |v:errors|.
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.
Parameters: ~
- • {fname-one} (`string`)
- • {fname-two} (`string`)
+ • {fname_one} (`string`)
+ • {fname_two} (`string`)
Return: ~
(`0|1`)
diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index f40a94a442..bde3101479 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -221,16 +221,16 @@ function vim.fn.assert_beeps(cmd) end
--- @return 0|1
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|.
--- 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.
---
---- @param fname-one string
---- @param fname-two string
+--- @param fname_one string
+--- @param fname_two string
--- @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
--- message is added to |v:errors|. Also see |assert-return|.
diff --git a/src/nvim/eval.lua b/src/nvim/eval.lua
index d60e9bd290..69f36796b9 100644
--- a/src/nvim/eval.lua
+++ b/src/nvim/eval.lua
@@ -326,17 +326,17 @@ M.funcs = {
args = { 2, 3 },
base = 1,
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|.
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.
]=],
name = 'assert_equalfile',
- params = { { 'fname-one', 'string' }, { 'fname-two', 'string' } },
+ params = { { 'fname_one', 'string' }, { 'fname_two', 'string' } },
returns = '0|1',
- signature = 'assert_equalfile({fname-one}, {fname-two})',
+ signature = 'assert_equalfile({fname_one}, {fname_two})',
},
assert_exception = {
args = { 1, 2 },