diff options
| author | Julian Berman <Julian@GrayVines.com> | 2020-01-08 06:37:38 +0000 |
|---|---|---|
| committer | Julian Berman <Julian@GrayVines.com> | 2020-01-08 06:37:38 +0000 |
| commit | 4df4b5054b6141b59ca78765b5637b34b02968cf (patch) | |
| tree | 3d001103f4159d30e5fb1c210f4e4366cd76e5f7 /docs | |
| parent | 2da9c6875fd47c9b59b008860b9af400b816b440 (diff) | |
| download | jsonschema-4df4b5054b6141b59ca78765b5637b34b02968cf.tar.gz | |
Tighten up the wording here.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/faq.rst | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/docs/faq.rst b/docs/faq.rst index 9e6bca9..4e1d244 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -138,11 +138,12 @@ number: 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 the extensive introspection provided in - `jsonschema.exceptions.ValidationError`\s instead to make meaningful - assertions about what failed. + * the exact wording and contents of error messages; typical reasons + to rely on this seem to involve downstream tests in packages using + `jsonschema`. These use cases are encouraged to use the extensive + introspection provided in `jsonschema.exceptions.ValidationError`\s + instead to make meaningful assertions about what failed rather than + relying on *how* what failed is explained to a human. * the order in which validation errors are returned or raised |