Skip to content

Commit b782bcb

Browse files
committed
revert usage
1 parent bb53ea5 commit b782bcb

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

docs/usage.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -95,12 +95,11 @@ optional specifications:
9595

9696
The :meth:`pystac_client.Client.conforms_to` method is used to check conformance
9797
against conformance classes (specs). To check an API for support for a given spec,
98-
pass the `conforms_to` function a :class:`ConformanceClasses` enum value.
98+
pass the `conforms_to` function the name of a :class:`ConformanceClasses`.
9999

100100
.. code-block:: python
101101
102-
>>> from pystac_client import ConformanceClasses
103-
>>> catalog.conforms_to(ConformanceClasses.ITEM_SEARCH)
102+
>>> catalog.conforms_to("ITEM_SEARCH")
104103
True
105104
106105
If the API does not advertise conformance with a particular spec, but it does support
@@ -111,9 +110,9 @@ there are no ``"conformsTo"`` uris set at all. But they can be explicitly set:
111110
112111
>>> catalog = Client.open("https://earth-search.aws.element84.com/v0")
113112
<stdin>:1: NoConformsTo: Server does not advertise any conformance classes.
114-
>>> catalog.conforms_to(ConformanceClasses.ITEM_SEARCH)
113+
>>> catalog.conforms_to("ITEM_SEARCH")
115114
False
116-
>>> catalog.add_conforms_to(ConformanceClasses.ITEM_SEARCH)
115+
>>> catalog.add_conforms_to("ITEM_SEARCH")
117116
118117
Note, updating ``"conformsTo"`` does not change what the server supports, it just
119118
changes PySTAC client's understanding of what the server supports.

0 commit comments

Comments
 (0)