diff options
| author | Julian Berman <Julian@GrayVines.com> | 2013-11-12 07:55:28 -0500 |
|---|---|---|
| committer | Julian Berman <Julian@GrayVines.com> | 2013-11-12 07:55:28 -0500 |
| commit | d5df8519f145af55a66735d473f897a3fe150813 (patch) | |
| tree | 06f4ea1459ad3cb7f70438491fd99a6de8083cc7 /docs/creating.rst | |
| parent | 35b60f390098d3306c03eee27ceec8cf8a493579 (diff) | |
| download | jsonschema-d5df8519f145af55a66735d473f897a3fe150813.tar.gz | |
Make it even more explicit that extend/create operate on classes and return classes.
Diffstat (limited to 'docs/creating.rst')
| -rw-r--r-- | docs/creating.rst | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/creating.rst b/docs/creating.rst index 6c42162..74b11e4 100644 --- a/docs/creating.rst +++ b/docs/creating.rst @@ -8,9 +8,9 @@ Creating or Extending Validators .. autofunction:: create - Create a new validator. + Create a new validator (class). - :argument dict meta_schema: the meta schema for the new validator + :argument dict meta_schema: the meta schema for the new validator class :argument dict validators: a mapping from validator names to functions that validate the given name. Each function should take 4 arguments: a @@ -27,14 +27,14 @@ Creating or Extending Validators for this argument is probably fine. Instances of the returned validator can still have their types customized on a per-instance basis. - :returns: an :class:`jsonschema.IValidator` + :returns: a new :class:`jsonschema.IValidator` class .. autofunction:: extend - Create a new validator that extends an existing validator. + Create a new validator that extends an existing validator class. - :argument jsonschema.IValidator validator: an existing validator + :argument jsonschema.IValidator validator: an existing validator class :argument dict validators: a set of new validators to add to the new validator. @@ -50,7 +50,7 @@ Creating or Extending Validators :argument str version: a version for the new validator - :returns: an :class:`jsonschema.IValidator` + :returns: a new :class:`jsonschema.IValidator` class .. note:: Meta Schemas |