summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHong Xu <hong@topbug.net>2025-08-03 22:25:34 -0700
committernessita <124304+nessita@users.noreply.github.com>2025-11-10 12:51:51 -0300
commita4f76741340fb23566795e83f830a3f2d49acce0 (patch)
treed04fa781bee5b5b00fda6875cff6dd10805da51d
parentc4e07f94ebc1f9eaa3dae7b3dc6a2b9832182a10 (diff)
Clarified EmailValidator docs to specify it validates an email address.
Updated the EmailValidator docs in docs/ref/validators.txt to explicitly state that it validates an email address, to avoid confusion with validating email message content.
-rw-r--r--docs/ref/validators.txt4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/ref/validators.txt b/docs/ref/validators.txt
index 59eef7b35e..39b712695e 100644
--- a/docs/ref/validators.txt
+++ b/docs/ref/validators.txt
@@ -133,8 +133,8 @@ to, or in lieu of custom ``field.clean()`` methods.
:param code: If not ``None``, overrides :attr:`code`.
:param allowlist: If not ``None``, overrides :attr:`allowlist`.
- An :class:`EmailValidator` ensures that a value looks like an email, and
- raises a :exc:`~django.core.exceptions.ValidationError` with
+ An :class:`EmailValidator` ensures that a value looks like an email
+ address, and raises a :exc:`~django.core.exceptions.ValidationError` with
:attr:`message` and :attr:`code` if it doesn't. Values longer than 320
characters are always considered invalid.