Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs templates: document the Email type methods in more detail #5355

Merged
merged 1 commit into from
Jan 15, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions docs/templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down