Skip to content

Commit

Permalink
Better wording.
Browse files Browse the repository at this point in the history
Co-authored-by: Hynek Schlawack <hs@ox.cx>
  • Loading branch information
Julian and hynek committed Sep 10, 2022
1 parent 8046232 commit 18a855b
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
3 changes: 2 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,8 @@ They can be used when installing in order to include additional dependencies, e.
$ pip install jsonschema'[format]'
You will also want to read the `format validation documentation <https://python-jsonschema.readthedocs.io/en/latest/validate/#validating-formats>`_.
Be aware that the mere presence of these dependencies – or even the specification of ``format`` checks in a schema – do **not** activate format checks (as per specification).
Please read the `format validation documentation <https://python-jsonschema.readthedocs.io/en/latest/validate/#validating-formats>`_ for details.

.. start cut from PyPI
Expand Down
3 changes: 2 additions & 1 deletion docs/validate.rst
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,8 @@ Validating Formats
------------------

JSON Schema defines the :kw:`format` keyword which can be used to check if primitive types (``string``\s, ``number``\s, ``boolean``\s) conform to well-defined formats.
By default, as per the specification, no validation is enforced. Optionally however, validation can be enabled by hooking a `format-checking object <jsonschema.FormatChecker>` into a `Validator`.
By default, as per the specification, no validation is enforced.
Optionally however, validation can be enabled by hooking a `format-checking object <jsonschema.FormatChecker>` into a `Validator`.

.. doctest::

Expand Down

0 comments on commit 18a855b

Please sign in to comment.