From ac1be9374b429acf34837e5abc433f0a4b325b95 Mon Sep 17 00:00:00 2001 From: Ilya Grigoriev Date: Mon, 13 Jan 2025 21:05:19 -0800 Subject: [PATCH] docs templates: document the Email type methods in more detail --- docs/templates.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/templates.md b/docs/templates.md index cc977762c..bcc69a5e2 100644 --- 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