From 94b4a1fc99b09a7b3a4bafd6aa2c8b8f9ecab944 Mon Sep 17 00:00:00 2001 From: Tobias Ulmer Date: Wed, 28 Jun 2017 19:02:38 +0200 Subject: [PATCH] err: improve documentation Signed-off-by: Tobias Ulmer --- generic/err.lua | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/generic/err.lua b/generic/err.lua index 2a5fd77..3d324bf 100644 --- a/generic/err.lua +++ b/generic/err.lua @@ -43,9 +43,10 @@ function err.append(e, format, ...) return e end ---- insert an error object into another one +--- Insert an error object into another one. -- @param e table: the error object --- @param re table: the error object to insert +-- @param re The error object to insert OR a format string used to creating a +-- new error object. -- @param ... list of strings required for the format string -- @return table: the error object function err.cat(e, re, ...) -- 2.39.5