Skip to content

Commit 3a1a6ea

Browse files
committed
Explicitly note you probably don't mean to touch Resolver.
1 parent 67d53f8 commit 3a1a6ea

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

referencing/_core.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -536,6 +536,12 @@ class Resolver(Generic[D]):
536536
Resolvers help resolve references (including relative ones) by
537537
pairing a fixed base URI with a `Registry`.
538538
539+
This object, under normal circumstances, is expected to be used by
540+
*implementers of libraries* built on top of `referencing` (e.g. JSON Schema
541+
implementations or other libraries resolving JSON references),
542+
not directly by end-users populating registries or while writing
543+
schemas or other resources.
544+
539545
References are resolved against the base URI, and the combined URI
540546
is then looked up within the registry.
541547

0 commit comments

Comments
 (0)