summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJulian Berman <Julian@GrayVines.com>2013-07-28 21:16:40 -0400
committerJulian Berman <Julian@GrayVines.com>2013-07-28 21:16:40 -0400
commitdc9e996c5dc53963c82adf06c27583407ce1e462 (patch)
tree8563e2b736fe06a342f638b61aa346c8b1ddf641
parentf78acbdc12cd7f8e2f18c45a729d051aa426a9c1 (diff)
downloadjsonschema-dc9e996c5dc53963c82adf06c27583407ce1e462.tar.gz
Fight with reST
-rw-r--r--docs/faq.rst15
1 files changed, 8 insertions, 7 deletions
diff --git a/docs/faq.rst b/docs/faq.rst
index fc6c27b..32775ac 100644
--- a/docs/faq.rst
+++ b/docs/faq.rst
@@ -70,19 +70,20 @@ The full picture requires defining what constitutes a backwards-incompatible
change.
The following are simple examples of things considered public API, and
-therefore should *not* be changed without bumping a major version number::
+therefore should *not* be changed without bumping a major version number:
* module names and contents, when not marked private by Python convention
- (leading underscore)
+ (a single leading underscore)
* function and object signature (parameter order and name)
-The following are *not* considered public API and may change without notice::
+The following are *not* considered public API and may change without notice:
- * the exact wording and contents of error messages; typical reasons to do
- this seem to involve unit tests. API users are encouraged to use
- :class:`ValidationError.validator` and friends instead, which are
- dependable.
+ * the exact wording and contents of error messages; typical
+ reasons to do this seem to involve unit tests. API users are
+ encouraged to use the extensive introspection provided in
+ :class:`~jsonschema.exceptions.ValidationError`\s instead to make
+ meaningful assertions about what failed.
* the order in which validation errors are returned or raised