Extend the documentation

voiio · Aug 17, 2023 · b74e368 · b74e368
1 parent 0247130
commit b74e368
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/emark/message.py b/emark/message.py
@@ -194,7 +194,15 @@ def get_subject(self, **context):
         return self.subject % context
 
     def get_preheader(self):
-        """Return the email's preheader."""
+        """
+        Return the email's preheader.
+
+        A brief text that recipients will see in their inbox before opening the email
+        along with the subject. Unless explicitly set, the preheader will be the first
+        paragraph of the email's body.
+        Can be useful to grab the recipient's attention and/or simplify their workflow
+        (e.g. by providing a one-time-password).
+        """
         return ""
 
     def get_markdown(self, context, utm):