[incubator-ponymail-foal] branch master updated: Fix up comments

[se...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

sebb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-ponymail-foal.git


The following commit(s) were added to refs/heads/master by this push:
     new f1ad8d9  Fix up comments
f1ad8d9 is described below

commit f1ad8d9dea0757ee1da9494efeb064626260d4f4
Author: Sebb <se...@apache.org>
AuthorDate: Fri Sep 4 17:09:46 2020 +0100

    Fix up comments
---
 tools/plugins/generators.py | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/tools/plugins/generators.py b/tools/plugins/generators.py
index 820ae26..122633d 100644
--- a/tools/plugins/generators.py
+++ b/tools/plugins/generators.py
@@ -159,13 +159,15 @@ def full(msg, _body, lid, _attachments, _raw_msg):
     (including server-dependent data)
     The id is almost certainly unique,
     but different copies of the message are likely to have different headers, thus ids
+    WARNING: the archiver by default adds an archived-at header with the current time.
+    This is included in the hash, so messages will get different Permalinks if reloaded from source
 
     Parameters:
     msg - the parsed message
     _body - the parsed text content (not used)
     lid - list id
     _attachments - list of attachments (not used)
-    raw_msg - the original message bytes (not used)
+    _raw_msg - the original message bytes (not used)
 
     Returns: "<hash>@<lid>" where hash is sha224 of message bytes
     """