Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/stevedonovan/Penlight.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThijs Schreijer <thijs@thijsschreijer.nl>2022-01-06 02:14:48 +0300
committerThijs Schreijer <thijs@thijsschreijer.nl>2022-01-06 13:49:53 +0300
commit651d3f4080bc3ab3561873d50e35ac81df63e736 (patch)
tree90fa1a5f4a925e3aa3f202b525c2f13caacc5cd0
parent8ae24aa1e450644d56d436772c28582af9ccbad4 (diff)
docs(unpack) minor doc fix for 'unpack' functions
-rw-r--r--lua/pl/compat.lua2
-rw-r--r--lua/pl/utils.lua2
2 files changed, 2 insertions, 2 deletions
diff --git a/lua/pl/compat.lua b/lua/pl/compat.lua
index 1707ef6..a4c9841 100644
--- a/lua/pl/compat.lua
+++ b/lua/pl/compat.lua
@@ -165,7 +165,7 @@ end
-- See `utils.unpack` for a version that is nil-safe.
-- @param t table to unpack
-- @param[opt] i index from which to start unpacking, defaults to 1
--- @param[opt] t index of the last element to unpack, defaults to #t
+-- @param[opt] j index of the last element to unpack, defaults to #t
-- @return multiple return values from the table
-- @function table.unpack
-- @see utils.unpack
diff --git a/lua/pl/utils.lua b/lua/pl/utils.lua
index 66edda6..7d1abed 100644
--- a/lua/pl/utils.lua
+++ b/lua/pl/utils.lua
@@ -60,7 +60,7 @@ utils.pack = table.pack -- added here to be symmetrical with unpack
-- that this one DOES honor the `n` field in the table `t`, such that it is 'nil-safe'.
-- @param t table to unpack
-- @param[opt] i index from which to start unpacking, defaults to 1
--- @param[opt] t index of the last element to unpack, defaults to `t.n` or `#t`
+-- @param[opt] j index of the last element to unpack, defaults to `t.n` or else `#t`
-- @return multiple return values from the table
-- @function utils.unpack
-- @see compat.unpack