diff options
| author | Julian Berman <Julian@GrayVines.com> | 2013-04-10 00:14:16 -0400 |
|---|---|---|
| committer | Julian Berman <Julian@GrayVines.com> | 2013-04-10 00:14:16 -0400 |
| commit | 14a6b96c12d9e3170e13b143e4250017b6a85a0c (patch) | |
| tree | 37751aa13ecf544bd5a88b1d09ef131a832c2f7b /docs/errors.rst | |
| parent | 26440898d272c7a88093a3ee844f7b43ce90c16b (diff) | |
| download | jsonschema-14a6b96c12d9e3170e13b143e4250017b6a85a0c.tar.gz | |
Clarify instance attribute.
Diffstat (limited to 'docs/errors.rst')
| -rw-r--r-- | docs/errors.rst | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/docs/errors.rst b/docs/errors.rst index 702b4db..dea05da 100644 --- a/docs/errors.rst +++ b/docs/errors.rst @@ -42,7 +42,12 @@ raised or returned, depending on which method or function is used. .. attribute:: instance - The instance that was being validated. + The instance that was being validated. This will differ from the + instance originally passed into validate if the validator was in the + process of validating a (possibly nested) element within the top-level + instance. The path within the top-level instance (i.e. + :attr:`ValidationError.path`) could be used to find this object, but it + is provided for convenience. .. attribute:: context |