summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJulian Berman <Julian@GrayVines.com>2013-02-17 00:08:44 -0500
committerJulian Berman <Julian@GrayVines.com>2013-02-17 00:08:44 -0500
commit5f0d289e0e00aea8a7e9c8af95d0afad75ee0d21 (patch)
tree4f3300c135d29f99a60f585fa076e145858cca11 /docs
parent0fb2bc6f96c4be1d0b46ce464a2b6a818f73d4dc (diff)
downloadjsonschema-5f0d289e0e00aea8a7e9c8af95d0afad75ee0d21.tar.gz
Too hard, too long.
Diffstat (limited to 'docs')
-rw-r--r--docs/validate.rst12
1 files changed, 10 insertions, 2 deletions
diff --git a/docs/validate.rst b/docs/validate.rst
index 48ee032..a564cf9 100644
--- a/docs/validate.rst
+++ b/docs/validate.rst
@@ -309,14 +309,22 @@ with.
Check if the instance is a valid e-mail address.
- Checking is based on `RFC 2822`_
-
>>> is_email("joe.bloggs@example.com")
True
>>> is_email("joe.bloggs")
False
+ .. note::
+
+ This is *not* done in strict compliance of `RFC 2822`_ and / or `RFC
+ 5322`_.
+
+ The only constraint is that the instance contain an ``@`` sign. If you
+ want stricter compliance, either change what you want or add and
+ register your own checker.
+
.. _RFC 2822: http://tools.ietf.org/html/rfc2822
+ .. _RFC 5322: http://tools.ietf.org/html/rfc5322
.. autofunction:: is_host_name