review

python-attrs · Mar 8, 2019 · 633107f · 633107f
1 parent 77317fa
commit 633107f
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 3 deletions.
diff --git a/src/attr/_make.py b/src/attr/_make.py
@@ -711,7 +711,7 @@ def _add_method_dunders(self, method):
             pass
 
         try:
-            method.__doc__ = "Method generated by attrs for {}".format(
+            method.__doc__ = "Method generated by attrs for {}.".format(
                 self._cls.__qualname__
             )
         except AttributeError:

diff --git a/tests/test_make.py b/tests/test_make.py
@@ -1483,10 +1483,32 @@ class B(A):
 
 
 class TestDocs:
-    def test_init_docs(self):
+    @pytest.mark.parametrize(
+        "meth_name",
+        [
+            "__init__",
+            "__repr__",
+            "__eq__",
+            "__ne__",
+            "__lt__",
+            "__le__",
+            "__gt__",
+            "__ge__",
+        ],
+    )
+    def test_docs(self, meth_name):
+        """
+        Tests the presence and correctness of the documentation
+        for the generated methods
+        """
+
         @attr.s
         class A(object):
             pass
 
         if hasattr(A, "__qualname__"):
-            assert A.__qualname__ in A.__init__.__doc__
+            method = getattr(A, meth_name)
+            expected = "Method generated by attrs for {}.".format(
+                A.__qualname__
+            )
+            assert expected == method.__doc__