From: Tobias Ulmer <tu@emlix.com>
Date: Wed, 28 Jun 2017 17:02:38 +0000 (+0200)
Subject: err: improve documentation
X-Git-Tag: e2factory-2.3.18rc1~109
X-Git-Url: https://git.e2factory.org/?a=commitdiff_plain;h=94b4a1fc99b09a7b3a4bafd6aa2c8b8f9ecab944;p=e2factory.git

err: improve documentation

Signed-off-by: Tobias Ulmer <tu@emlix.com>
---

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, ...)