diff options
author | Julian Berman <Julian@GrayVines.com> | 2013-05-21 07:30:54 -0400 |
---|---|---|
committer | Julian Berman <Julian@GrayVines.com> | 2013-05-21 07:30:54 -0400 |
commit | c170684c2dee852a23cf9d731f37bf3802c2d903 (patch) | |
tree | 1cd53db009e940e86ab107060acfef154701a37e | |
parent | 42e97d8d35c88fd434898fcec22a19875794b185 (diff) | |
download | jsonschema-c170684c2dee852a23cf9d731f37bf3802c2d903.tar.gz |
Add a docstring.
-rw-r--r-- | docs/creating.rst | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/creating.rst b/docs/creating.rst index d2693d8..87fcb09 100644 --- a/docs/creating.rst +++ b/docs/creating.rst @@ -47,6 +47,16 @@ Creating or Extending Validators .. autofunction:: validator_for + Retrieve the validator appropriate for validating the given schema. + + Uses the :validator:`$schema` property that should be present in the given + schema to look up the appropriate validator. + + :argument schema: the schema to look at + :argument default: the default to return if the appropriate validator + cannot be determined. If unprovided, the default will be to just return + :class:`Draft4Validator` + .. autofunction:: validates |