summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJon Staab <shtaab@gmail.com>2018-05-09 09:13:33 -0700
committerJon Staab <shtaab@gmail.com>2018-05-09 09:13:33 -0700
commit22549769dc6539bf3eb479844b9309c8fdc84596 (patch)
tree26974960d2f554d24dab01c8f2b1baca00ebe6b1 /docs
parent47e032a84fa7b3b18f97876d49c1cb30b3165af3 (diff)
downloadjsonschema-22549769dc6539bf3eb479844b9309c8fdc84596.tar.gz
Re-wording email disclaimer to fit the reasoning behind it
Diffstat (limited to 'docs')
-rw-r--r--docs/validate.rst11
1 files changed, 6 insertions, 5 deletions
diff --git a/docs/validate.rst b/docs/validate.rst
index e6c6d5f..43b6f00 100644
--- a/docs/validate.rst
+++ b/docs/validate.rst
@@ -278,12 +278,13 @@ validation can be enabled by hooking in a format-checking object into an
Traceback (most recent call last):
...
ValidationError: "-12" is not a "hostname"
-
+
.. note::
-
- For the sake of speed and simplicity, format checkers may implement only
- partial validation; in particular, full rfc5322_ validation for email
- addresses is not provided.
+
+ Since fully validating an email address requires checking that it is
+ formatted correctly, as well as that it belongs to the correct recipient,
+ the email format validator only provides a sanity check, not full rfc5322_
+ validation.
.. autoclass:: FormatChecker
:members: