Merge remote-tracking branch 'gazpachoking/better_error_messages'

1 files changed, 17 insertions, 4 deletions

diff --git a/docs/errors.rst b/docs/errors.rst
index 6d3a457..65bdbf4 100644
--- a/docs/errors.rst
+++ b/docs/errors.rst
@@ -96,9 +96,9 @@ The error messages in this situation are not very helpful on their own:
 
     >>> for error in errors:
     ...     print(error.message)
-    The instance is not valid under any of the given schemas
-    The instance is not valid under any of the given schemas
-    The instance is not valid under any of the given schemas
+    {} is not valid under any of the given schemas
+    3 is not valid under any of the given schemas
+    'foo' is not valid under any of the given schemas
 
 If we look at :attr:`~ValidationError.path` on each of the errors, we can find
 out which elements in the instance correspond to each of the errors. In
@@ -130,7 +130,7 @@ to the :attr:`~ValidationError.schema_path` of the parent error.
 
     >>> for error in errors:
     ...     for suberror in sorted(error.context, key=lambda e: e.schema_path):
-    ...         print(list(suberror.schema_path), suberror, sep=",")
+    ...         print(list(suberror.schema_path), suberror.message, sep=", ")
     [0, 'type'], {} is not of type 'string'
     [1, 'type'], {} is not of type 'integer'
     [0, 'type'], 3 is not of type 'string'
@@ -138,6 +138,19 @@ to the :attr:`~ValidationError.schema_path` of the parent error.
     [0, 'maxLength'], 'foo' is too long
     [1, 'type'], 'foo' is not of type 'integer'
 
+The string representation of an error combines some of these attributes for
+easier debugging.
+
+.. code-block:: python
+
+    >>> print(errors[1])
+    ValidationError: 3 is not valid under any of the given schemas
+        Failed validating 'anyOf' in schema['items']:
+            {'anyOf': [{'maxLength': 2, 'type': 'string'},
+                       {'minimum': 5, 'type': 'integer'}]}
+        On instance[1]:
+            3
+    <BLANKLINE>
 
 ErrorTrees
 ----------