docs templates: document the Email type methods in more detail

jj-vcs · Jan 14, 2025 · 0aac185 · 0aac185
1 parent be9483b
commit 0aac185
Showing 1 changed file with 8 additions and 2 deletions.
diff --git a/docs/templates.md b/docs/templates.md
@@ -166,10 +166,16 @@ The following methods are defined.
 
 ### Email type
 
+The email field of a signature may or may not look like an email address. It may
+be empty, may not contain the symbol `@`, and could in principle contain
+multiple `@`s.
+
 The following methods are defined.
 
-* `.local() -> String`
-* `.domain() -> String`
+* `.local() -> String`: the part of the email before the first `@`, usually the
+  username.
+* `.domain() -> String`: the part of the email after the first `@` or the empty
+  string.
 
 ### Integer type