File tree Expand file tree Collapse file tree 1 file changed +8
-7
lines changed Expand file tree Collapse file tree 1 file changed +8
-7
lines changed Original file line number Diff line number Diff line change @@ -70,19 +70,20 @@ The full picture requires defining what constitutes a backwards-incompatible
70
70
change.
71
71
72
72
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:
74
74
75
75
* module names and contents, when not marked private by Python convention
76
- (leading underscore)
76
+ (a single leading underscore)
77
77
78
78
* function and object signature (parameter order and name)
79
79
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:
81
81
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.
86
87
87
88
* the order in which validation errors are returned or raised
88
89
You can’t perform that action at this time.
0 commit comments