err: improve documentation

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

diff --git a/generic/err.lua b/generic/err.lua
index 2a5fd77957006eb66c63bcae7ffbe8ba7a36d56c..3d324bfdce6514ac6f62d925d2068961d20e28cc 100644 (file)
--- 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, ...)