Skip to content

Commit dc9e996

Browse files
committed
Fight with reST
1 parent f78acbd commit dc9e996

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

docs/faq.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -70,19 +70,20 @@ The full picture requires defining what constitutes a backwards-incompatible
7070
change.
7171

7272
The following are simple examples of things considered public API, and
73-
therefore should *not* be changed without bumping a major version number::
73+
therefore should *not* be changed without bumping a major version number:
7474

7575
* module names and contents, when not marked private by Python convention
76-
(leading underscore)
76+
(a single leading underscore)
7777

7878
* function and object signature (parameter order and name)
7979

80-
The following are *not* considered public API and may change without notice::
80+
The following are *not* considered public API and may change without notice:
8181

82-
* the exact wording and contents of error messages; typical reasons to do
83-
this seem to involve unit tests. API users are encouraged to use
84-
:class:`ValidationError.validator` and friends instead, which are
85-
dependable.
82+
* the exact wording and contents of error messages; typical
83+
reasons to do this seem to involve unit tests. API users are
84+
encouraged to use the extensive introspection provided in
85+
:class:`~jsonschema.exceptions.ValidationError`\s instead to make
86+
meaningful assertions about what failed.
8687

8788
* the order in which validation errors are returned or raised
8889

0 commit comments

Comments
 (0)