Check that every method and property has a docstring

Author: mwcraig

src/astro_image_display_api/api_test.py

@@ -906,3 +906,25 @@ def test_all_methods_accept_additional_kwargs(self, data, catalog, tmp_path):
             "The following methods failed when called with additional kwargs:\n\t"
             f"{'\n\t'.join(failed_methods)}"
         )
+
+    def test_every_method_attribute_has_docstring(self):
+        """
+        Check that every method and attribute in the protocol has a docstring.
+        """
+        from astro_image_display_api import ImageViewerInterface
+
+        all_methods_and_attributes = ImageViewerInterface.__protocol_attrs__
+
+        method_attrs_no_docs = []
+
+        for method in all_methods_and_attributes:
+            attr = getattr(self.image, method)
+            # Make list of methods and attributes that have no docstring
+            # and assert that list is empty at the end of the test.
+            if not attr.__doc__:
+                method_attrs_no_docs.append(method)
+
+        assert not method_attrs_no_docs, (
+            "The following methods and attributes have no docstring:\n\t"
+            f"{'\n\t'.join(method_attrs_no_docs)}"
+        )

tests/test_astro_image_display_api.py

@@ -72,3 +72,26 @@ def test_api_test_class_covers_all_attributes_and_only_those_attributes():
         "ImageWidgetAPITest does not access these "
         f"attributes/methods:\n{missing_attributes_msg}\n"
     )
+
+
+def test_every_method_attribute_has_docstring():
+    """
+    Check that every method and attribute in the protocol has a docstring.
+    """
+    from astro_image_display_api import ImageViewerInterface
+
+    all_methods_and_attributes = ImageViewerInterface.__protocol_attrs__
+
+    method_attrs_no_docs = []
+
+    for method in all_methods_and_attributes:
+        attr = getattr(ImageViewerInterface, method)
+        # Make list of methods and attributes that have no docstring
+        # and assert that list is empty at the end of the test.
+        if not attr.__doc__:
+            method_attrs_no_docs.append(method)
+
+    assert not method_attrs_no_docs, (
+        "The following methods and attributes have no docstring:\n\t"
+        f"{'\n\t'.join(method_attrs_no_docs)}"
+    )