Clarify conforms_to v. assert_conforms_to usage

Author: duckontheweb

pystac_client/client.py

@@ -94,7 +94,7 @@ def get_collections(self) -> Iterable[CollectionClient]:
         Return:
             Iterable[CollectionClient]: Iterator through Collections in Catalog/API
         """
-        if self._stac_io.assert_conforms_to(ConformanceClasses.COLLECTIONS):
+        if self._stac_io.conforms_to(ConformanceClasses.COLLECTIONS):
             url = self.get_self_href() + '/collections'
             for page in self._stac_io.get_pages(url):
                 if 'collections' not in page:
@@ -111,7 +111,7 @@ def get_items(self) -> Iterable["Item_Type"]:
         Return:
             Iterable[Item]:: Generator of items whose parent is this catalog.
         """
-        if self._stac_io.assert_conforms_to(ConformanceClasses.ITEM_SEARCH):
+        if self._stac_io.conforms_to(ConformanceClasses.ITEM_SEARCH):
             search = self.search()
             yield from search.get_items()
         else:
@@ -126,7 +126,7 @@ def get_all_items(self) -> Iterable["Item_Type"]:
                 catalogs or collections connected to this catalog through
                 child links.
         """
-        if self._stac_io.assert_conforms_to(ConformanceClasses.ITEM_SEARCH):
+        if self._stac_io.conforms_to(ConformanceClasses.ITEM_SEARCH):
             yield from self.get_items()
         else:
             yield from super().get_items()

pystac_client/stac_api_io.py

@@ -210,21 +210,16 @@ def get_pages(self, url, method='GET', parameters={}) -> Iterator[Dict]:
             next_link = next((link for link in page.get('links', []) if link['rel'] == 'next'),
                              None)
 
-    def assert_conforms_to(self, conformance_class: ConformanceClasses):
-        """Whether the API conforms to the given standard. This method only checks against the ``"conformsTo"``
-        property from the API landing page and does not make any additional calls to a ``/conformance`` endpoint
-        even if the API provides such an endpoint.
+    def assert_conforms_to(self, conformance_class: ConformanceClasses) -> None:
+        """Raises a :exc:`NotImplementedError` if the API does not publish the given conformance class. This method
+        only checks against the ``"conformsTo"`` property from the API landing page and does not make any additional
+        calls to a ``/conformance`` endpoint even if the API provides such an endpoint.
 
         Args:
-            key: The ``ConformanceClasses`` key to check conformance against.
-
-        Return:
-            bool: Indicates if the API conforms to the given spec or URI.
+            conformance_class: The ``ConformanceClasses`` key to check conformance against.
         """
         if not self.conforms_to(conformance_class):
             raise NotImplementedError(f"{conformance_class} not supported")
-        else:
-            return True
 
     def conforms_to(self, conformance_class: ConformanceClasses) -> bool:
         """Whether the API conforms to the given standard. This method only checks against the ``"conformsTo"``