diff --git a/docs/faq.rst b/docs/faq.rst index 629f9c50d..c3300b0a8 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -79,7 +79,7 @@ How do I configure a base URI for ``$ref`` resolution using local files? `jsonschema` supports loading schemas from the filesystem. -The most common mistake when configuring a :class:`~jsonschema.RefResolver` +The most common mistake when configuring a `jsonschema.validators.RefResolver` to retrieve schemas from the local filesystem is to give it a base URI which points to a directory, but forget to add a trailing slash. @@ -187,8 +187,8 @@ be valid under the schema.) See the above-linked document for more info on how this works, but basically, it just extends the :kw:`properties` keyword on a -`jsonschema.Draft202012Validator` to then go ahead and update all the -defaults. +`jsonschema.validators.Draft202012Validator` to then go ahead and update +all the defaults. .. note:: diff --git a/jsonschema/__init__.py b/jsonschema/__init__.py index 75f294696..7e3b91e74 100644 --- a/jsonschema/__init__.py +++ b/jsonschema/__init__.py @@ -4,8 +4,9 @@ The main functionality is provided by the validator classes for each of the supported JSON Schema versions. -Most commonly, `validate` is the quickest way to simply validate a given -instance under a schema, and will create a validator for you. +Most commonly, `jsonschema.validators.validate` is the quickest way to simply +validate a given instance under a schema, and will create a validator +for you. """ import warnings diff --git a/jsonschema/protocols.py b/jsonschema/protocols.py index 89b8ac5a3..0bdb9eb75 100644 --- a/jsonschema/protocols.py +++ b/jsonschema/protocols.py @@ -53,9 +53,9 @@ class Validator(Protocol): will validate with. It is assumed to be valid, and providing an invalid schema can lead to undefined behavior. See `Validator.check_schema` to validate a schema first. - :argument resolver: an instance of `jsonschema.RefResolver` that will be - used to resolve :kw:`$ref` properties (JSON references). If - unprovided, one will be created. + :argument resolver: an instance of `jsonschema.validators.RefResolver` + that will be used to resolve :kw:`$ref` properties (JSON references). + If unprovided, one will be created. :argument format_checker: an instance of `jsonschema.FormatChecker` whose `jsonschema.FormatChecker.conforms` method will be called to check and see if instances conform to each :kw:`format`