From af86042a36c7e81e426d21e5170edd23da0e4149 Mon Sep 17 00:00:00 2001 From: Chase Sterling Date: Thu, 4 Apr 2013 10:36:09 -0400 Subject: [PATCH] Update docs for descend method --- docs/creating.rst | 9 +++++---- 1 file 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.