summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJulian Berman <Julian@GrayVines.com>2017-12-24 17:12:29 -0500
committerJulian Berman <Julian@GrayVines.com>2017-12-24 17:12:29 -0500
commitb60f4c7c0dc678d7e8dd3178ac0772202e0a44da (patch)
treeeb3e3118f5834a8e5d1536e32b2718d5f5b33ac9 /docs
parent118e6a2412afcb64544c607425fec2ef346880bf (diff)
downloadjsonschema-b60f4c7c0dc678d7e8dd3178ac0772202e0a44da.tar.gz
Rewording and keep fighting with Sphinx.
Diffstat (limited to 'docs')
-rw-r--r--docs/validate.rst52
1 files changed, 34 insertions, 18 deletions
diff --git a/docs/validate.rst b/docs/validate.rst
index e6411ff..8d304b6 100644
--- a/docs/validate.rst
+++ b/docs/validate.rst
@@ -55,13 +55,17 @@ classes should adhere to.
.. deprecated:: 2.7.0
- Instead, create a custom type checker and extend the validator.
+ Use `TypeChecker.redefine` and `jsonschema.validators.extend`
+ instead of this argument.
See `validating-types` for details.
- If used, this overrides or extends the list of known type when
- validating the :validator:`type` property. Should map strings (type
- names) to class objects that will be checked via `isinstance`.
+ If used, this overrides or extends the list of known types when
+ validating the :validator:`type` property.
+
+ What is provided should map strings (type names) to class objects
+ that will be checked via `isinstance`.
+
.. attribute:: META_SCHEMA
@@ -75,8 +79,9 @@ classes should adhere to.
information see `creating-validators`.
.. attribute:: TYPE_CHECKER
- A `TypeChecker` that can be used validating :validator:`type`
- properties in JSON schemas.
+
+ A `TypeChecker` that will be used when validating :validator:`type`
+ properties in JSON schemas.
.. attribute:: schema
@@ -86,12 +91,17 @@ classes should adhere to.
.. deprecated:: 2.7.0
- Use of this attribute is deprecated in favor of the the new type
- checkers.
+ Use of this attribute is deprecated in favor of the new `type
+ checkers <TypeChecker>`.
+
+ See `validating-types` for details.
+
+ For backwards compatibility on existing validator classes, a mapping of
+ JSON types to Python class objects which define the Python types for
+ each JSON type.
- It provides mappings of JSON types to Python types that will
- be converted to functions and redefined in this object's type checker
- if one is not provided.
+ Any existing code using this attribute should likely transition to
+ using `TypeChecker.is_type`.
.. classmethod:: check_schema(schema)
@@ -100,7 +110,7 @@ classes should adhere to.
Raises:
- `jsonschema.exceptions.SchemaError`: if the schema is invalid
+ jsonschema.exceptions.SchemaError: if the schema is invalid
.. method:: is_type(instance, type)
@@ -303,12 +313,18 @@ validation can be enabled by hooking in a format-checking object into an
Any instance created after this function is called will pick up the
supplied checker.
- :argument str format: the format that the decorated function will check
- :argument Exception raises: the exception(s) raised
- by the decorated function when an invalid instance is
- found. The exception object will be accessible as the
- `jsonschema.exceptions.ValidationError.cause` attribute
- of the resulting validation error.
+ Arguments:
+
+ format (str):
+
+ the format that the decorated function will check
+
+ raises (Exception):
+
+ the exception(s) raised by the decorated function when an invalid
+ instance is found. The exception object will be accessible as the
+ `jsonschema.exceptions.ValidationError.cause` attribute of the
+ resulting validation error.
.. autoexception:: FormatError