aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc
diff options
context:
space:
mode:
authorLewis Russell <lewis6991@gmail.com>2023-04-05 17:19:53 +0100
committerGitHub <noreply@github.com>2023-04-05 17:19:53 +0100
commit34ac75b32927328a0c691c5bda987c0fdb5ce9eb (patch)
treee627ce838ebc6d1670a2ed1c30fad237ca8c3e0c /runtime/doc
parent56e4d79b280b2da1c8d9705d2f300cd93e955f53 (diff)
downloadrneovim-34ac75b32927328a0c691c5bda987c0fdb5ce9eb.tar.gz
rneovim-34ac75b32927328a0c691c5bda987c0fdb5ce9eb.tar.bz2
rneovim-34ac75b32927328a0c691c5bda987c0fdb5ce9eb.zip
refactor: rename local API alias from a to api
Problem: Codebase inconsistently binds vim.api onto a or api. Solution: Use api everywhere. a as an identifier is too short to have at the module level.
Diffstat (limited to 'runtime/doc')
-rw-r--r--runtime/doc/api.txt14
1 files changed, 7 insertions, 7 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt
index 46816856b9..52c3f7fa97 100644
--- a/runtime/doc/api.txt
+++ b/runtime/doc/api.txt
@@ -2570,17 +2570,17 @@ nvim_buf_get_extmarks({buffer}, {ns_id}, {start}, {end}, {opts})
`limit`, to get the first marks prior to a given position.)
Example: >lua
- local a = vim.api
- local pos = a.nvim_win_get_cursor(0)
- local ns = a.nvim_create_namespace('my-plugin')
+ local api = vim.api
+ local pos = api.nvim_win_get_cursor(0)
+ local ns = api.nvim_create_namespace('my-plugin')
-- Create new extmark at line 1, column 1.
- local m1 = a.nvim_buf_set_extmark(0, ns, 0, 0, {})
+ local m1 = api.nvim_buf_set_extmark(0, ns, 0, 0, {})
-- Create new extmark at line 3, column 1.
- local m2 = a.nvim_buf_set_extmark(0, ns, 2, 0, {})
+ local m2 = api.nvim_buf_set_extmark(0, ns, 2, 0, {})
-- Get extmarks only from line 3.
- local ms = a.nvim_buf_get_extmarks(0, ns, {2,0}, {2,0}, {})
+ local ms = api.nvim_buf_get_extmarks(0, ns, {2,0}, {2,0}, {})
-- Get all marks in this buffer + namespace.
- local all = a.nvim_buf_get_extmarks(0, ns, 0, -1, {})
+ local all = api.nvim_buf_get_extmarks(0, ns, 0, -1, {})
print(vim.inspect(ms))
<