openstack/deb-python-jsonschema
Code Issues Proposed changes

Start some creating docs.

Browse Source
This commit is contained in:
Julian Berman
2013-05-20 18:45:57 -04:00
parent 25fb92cd2c
commit 252fbedbd0
2 changed files with 14 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/creating.rst
View File

@@ -4,9 +4,13 @@
Creating or Extending Validators Creating or Extending Validators
================================ ================================
.. currentmodule:: jsonschema .. currentmodule:: jsonschema.validators
.. autoclass:: ValidatorMixin .. autofunction:: create
Create a new validator.
:returns: an :class:`jsonschema.IValidator`
.. autofunction:: validates .. autofunction:: validates

8
docs/validate.rst
View File

@@ -93,6 +93,14 @@ adhere to.
An object representing the validator's meta schema (the schema that An object representing the validator's meta schema (the schema that
describes valid schemas in the given version). describes valid schemas in the given version).
.. attribute:: VALIDATORS
A mapping of validators (:class:`str`\s) to functions that validate the
validator property with that name. Each function should take 4
arguments: the validator instance, the value of the current validator
property in the instance, the instance, and the schema. For more
information see :ref:`creating-validators`.
.. attribute:: schema .. attribute:: schema
The schema that was passed in when initializing the validator. The schema that was passed in when initializing the validator.