aboutsummaryrefslogtreecommitdiffhomepage
path: root/core
diff options
context:
space:
mode:
authorGravatar mitchell <70453897+orbitalquark@users.noreply.github.com>2022-03-19 01:08:11 -0400
committerGravatar mitchell <70453897+orbitalquark@users.noreply.github.com>2022-03-19 01:08:11 -0400
commit82e9a289a6bd4956c979d2fb123025b4d4396ed5 (patch)
tree6d509b9ffa2bd5fbd4498202dfb281ce59168a60 /core
parent54c6d6c45783ed03e06d4d5e931a986156a32f0e (diff)
Updated documentation on rearranging tabs and `move_buffer()`.
Diffstat (limited to 'core')
-rw-r--r--core/init.lua5
1 files changed, 4 insertions, 1 deletions
diff --git a/core/init.lua b/core/init.lua
index 56b7519f..aebc7da9 100644
--- a/core/init.lua
+++ b/core/init.lua
@@ -134,9 +134,12 @@ local view
-- The functions below are Lua C functions.
---
--- Moves the buffer at index *from* to index *to*, shifting other buffers as necessary.
+-- Moves the buffer at index *from* to index *to* in the `_BUFFERS` table, shifting other buffers
+-- as necessary.
+-- This changes the order buffers are displayed in in the tab bar and buffer browser.
-- @param from Index of the buffer to move.
-- @param to Index to move the buffer to.
+-- @see _BUFFERS
-- @class function
-- @name move_buffer
local move_buffer