openstack/deb-python-jsonschema
Code Issues Proposed changes

Update docs for descend method

Browse Source
This commit is contained in:
Chase Sterling
2013-04-04 10:36:09 -04:00
parent 45e20de246
commit af86042a36
1 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/creating.rst
View File

@@ -14,7 +14,8 @@ Creating or Extending Validators
Creating Validation Errors
--------------------------
Any validating function that recurses into an instance (e.g. ``properties`` or
``items``) must call ``appendleft`` on the :exc:`ValidationError.path`
attribute of the error in order to properly maintain where in the instance the
error occurred.
Any validating function that validates against a subschema should call
:meth:`ValidatorMixin.descend`, rather than :meth:`ValidatorMixin.iter_errors`.
If it recurses into the instance, or schema, it must set the ``path`` or
``schema_path`` in order to properly maintain where in the instance and schema
the error occurred.