digest: Improve developer docs

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

diff --git a/local/digest.lua b/local/digest.lua
index c386dbfb72099c2662fa75c2a18718f57d2d88d3..735c39876b52eeba545d6a2043952541181f5d68 100644 (file)
--- a/local/digest.lua
+++ b/local/digest.lua
@@ -330,7 +330,9 @@ end
 --
 -- @param dt A digest table with digest table entries.
 -- @param filename Filename to write digest entries into. The file will be
--- created or overwritten in case it already exists.
+--                 created or overwritten in case it already exists.
+-- @return True on success, false on error.
+-- @return Error object on failure.
 function digest.write(dt, filename)
     assert(type(dt) == "table")
     assert(type(filename) == "string")