diff options
| author | Maria José Solano <majosolano99@gmail.com> | 2023-09-24 21:39:59 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-09-24 21:39:59 -0700 |
| commit | db51548036ebe4b01c5b78aeca7a76aa71ab4fbe (patch) | |
| tree | 0098a2f64595e3c03a9acd4305f833d62a0b88f3 /runtime/lua | |
| parent | b3be7b741386bbbf076e87859cb1e3d990316f5c (diff) | |
| download | rneovim-db51548036ebe4b01c5b78aeca7a76aa71ab4fbe.tar.gz rneovim-db51548036ebe4b01c5b78aeca7a76aa71ab4fbe.tar.bz2 rneovim-db51548036ebe4b01c5b78aeca7a76aa71ab4fbe.zip | |
docs: do not use deprecated functions #25334
Diffstat (limited to 'runtime/lua')
| -rw-r--r-- | runtime/lua/vim/_editor.lua | 2 | ||||
| -rw-r--r-- | runtime/lua/vim/_meta/api.lua | 7 | ||||
| -rw-r--r-- | runtime/lua/vim/_options.lua | 2 |
3 files changed, 9 insertions, 2 deletions
diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua index e4a2dadb09..7f09fc8038 100644 --- a/runtime/lua/vim/_editor.lua +++ b/runtime/lua/vim/_editor.lua @@ -888,7 +888,7 @@ end --- Example: --- --- ```lua ---- local hl_normal = vim.print(vim.api.nvim_get_hl_by_name('Normal', true)) +--- local hl_normal = vim.print(vim.api.nvim_get_hl(0, { name = 'Normal' })) --- ``` --- --- @see |vim.inspect()| diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua index 81fa7ce7ec..5c51fbd146 100644 --- a/runtime/lua/vim/_meta/api.lua +++ b/runtime/lua/vim/_meta/api.lua @@ -425,6 +425,7 @@ function vim.api.nvim_buf_get_number(buffer) end --- @return integer function vim.api.nvim_buf_get_offset(buffer, index) end +--- @deprecated --- @param buffer integer --- @param name string --- @return any @@ -632,6 +633,7 @@ function vim.api.nvim_buf_set_mark(buffer, name, line, col, opts) end --- @param name string Buffer name function vim.api.nvim_buf_set_name(buffer, name) end +--- @deprecated --- @param buffer integer --- @param name string --- @param value any @@ -1283,10 +1285,12 @@ function vim.api.nvim_get_mode() end --- @return table<string,any> function vim.api.nvim_get_namespaces() end +--- @deprecated --- @param name string --- @return any function vim.api.nvim_get_option(name) end +--- @deprecated --- @param name string --- @return table<string,any> function vim.api.nvim_get_option_info(name) end @@ -1912,6 +1916,7 @@ function vim.api.nvim_set_hl_ns_fast(ns_id) end --- "callback" is equivalent to returning an empty string. function vim.api.nvim_set_keymap(mode, lhs, rhs, opts) end +--- @deprecated --- @param name string --- @param value any function vim.api.nvim_set_option(name, value) end @@ -2115,6 +2120,7 @@ function vim.api.nvim_win_get_height(window) end --- @return integer function vim.api.nvim_win_get_number(window) end +--- @deprecated --- @param window integer --- @param name string --- @return any @@ -2197,6 +2203,7 @@ function vim.api.nvim_win_set_height(window, height) end --- @param ns_id integer the namespace to use function vim.api.nvim_win_set_hl_ns(window, ns_id) end +--- @deprecated --- @param window integer --- @param name string --- @param value any diff --git a/runtime/lua/vim/_options.lua b/runtime/lua/vim/_options.lua index 6a3413b597..b83a8dd4b1 100644 --- a/runtime/lua/vim/_options.lua +++ b/runtime/lua/vim/_options.lua @@ -127,7 +127,7 @@ end --- @param name string local function get_options_info(name) - local info = api.nvim_get_option_info(name) + local info = api.nvim_get_option_info2(name, {}) info.metatype = get_option_metatype(name, info) return info end |