From cb220baabc0cdd45784deb477d83cd93b5d343f2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?LAURENS=20J=C3=A9r=C3=B4me?= Date: Fri, 31 May 2024 16:01:01 +0200 Subject: [PATCH] Documentation of Map.lua --- lua/pl/Map.lua | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/lua/pl/Map.lua b/lua/pl/Map.lua index 572b22ad..0899d2eb 100644 --- a/lua/pl/Map.lua +++ b/lua/pl/Map.lua @@ -37,10 +37,14 @@ local function makelist(t) return setmetatable(t, require('pl.List')) end ---- list of keys. +--- return a List of all keys. +-- @class function +-- @name Map:keys Map.keys = tablex.keys ---- list of values. +--- return a List of all values. +-- @class function +-- @name Map:keys Map.values = tablex.values --- return an iterator over all key-value pairs. @@ -48,7 +52,7 @@ function Map:iter () return pairs(self) end ---- return a List of all key-value pairs, sorted by the keys. +--- return a List of all key-value pairs, sorted by the keys in ascending order. function Map:items() local ls = makelist(tablex.pairmap (function (k,v) return makelist {k,v} end, self)) ls:sort(function(t1,t2) return t1[1] < t2[1] end)