diff options
author | Chase Sterling <chase.sterling@gmail.com> | 2013-04-04 10:36:09 -0400 |
---|---|---|
committer | Chase Sterling <chase.sterling@gmail.com> | 2013-04-04 10:36:09 -0400 |
commit | af86042a36c7e81e426d21e5170edd23da0e4149 (patch) | |
tree | 74a0acfa3a04b1605b075b5450d414a843588d0d /docs/creating.rst | |
parent | 45e20de2466b59bc7f9793069ebc353c9d17eafb (diff) | |
download | jsonschema-af86042a36c7e81e426d21e5170edd23da0e4149.tar.gz |
Update docs for descend method
Diffstat (limited to 'docs/creating.rst')
-rw-r--r-- | docs/creating.rst | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/docs/creating.rst b/docs/creating.rst index 7a3224c..75da8ed 100644 --- a/docs/creating.rst +++ b/docs/creating.rst @@ -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. |