summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorChase Sterling <chase.sterling@gmail.com>2013-04-11 13:45:55 -0400
committerChase Sterling <chase.sterling@gmail.com>2013-04-11 13:45:55 -0400
commit0c60638cb7505af0078de2c19c2bf100780b2dd7 (patch)
tree8b4ee4f27100fda910ece7e82f1441c30de592cb /docs
parent388d0d6947d7cdd49e13d46413e7ab1e1b739c84 (diff)
downloadjsonschema-0c60638cb7505af0078de2c19c2bf100780b2dd7.tar.gz
Add a table with available format checkers
Diffstat (limited to 'docs')
-rw-r--r--docs/validate.rst30
1 files changed, 17 insertions, 13 deletions
diff --git a/docs/validate.rst b/docs/validate.rst
index 9870ded..9085b25 100644
--- a/docs/validate.rst
+++ b/docs/validate.rst
@@ -262,19 +262,23 @@ be enabled by hooking in a format-checking object into an :class:`IValidator`.
There are a number of default checkers that :class:`FormatChecker`\s know how
to validate. Their names can be viewed by inspecting the
:attr:`FormatChecker.checkers` attribute. Certain checkers will only be
-available if an appropriate package is available for use, these are listed
-below.
-
-On OSes with the ``socket.inet_pton`` function, a checker for
-``ipv6`` will be present.
-
-If the rfc3987_ library is present, a checker for ``uri`` will be present.
-
-If the isodate_ library is present, a ``date-time`` checker will also be
-present.
-
-Additionally, if the webcolors_ library is present, a checker for ``color``
-related to CSS will be present.
+available if an appropriate package is available for use. The available
+checkers, along with their requirement (if any,) are listed below.
+
+========== ============
+Checker Requirement
+========== ============
+hostname
+ipv4
+ipv6 OS must have ``socket.inet_pton`` function
+email
+uri rfc3987_
+date-time isodate_
+date
+time
+regex
+color webcolors_
+========== ============
.. _isodate: http://pypi.python.org/pypi/isodate/