Add more docs for messages (#7912)

* add docs for useless-param-doc
* add docs for useless-type-doc
* add docs for useless-with-lock
* add docs for eq-without-hash

Co-authored-by: Pierre Sassoulas <[email protected]>

Author: clavedeluna

doc/data/messages/e/eq-without-hash/bad.py

@@ -0,0 +1,6 @@
+class Fruit:  # [eq-without-hash]
+    def __init__(self) -> None:
+        self.name = "apple"
+
+    def __eq__(self, other: object) -> bool:
+        return isinstance(other, Fruit) and other.name == self.name

doc/data/messages/e/eq-without-hash/details.rst

@@ -1 +1,9 @@
-# This is a placeholder for correct code for this message.
+class Fruit:
+    def __init__(self) -> None:
+        self.name = "apple"
+
+    def __eq__(self, other: object) -> bool:
+        return isinstance(other, Fruit) and other.name == self.name
+
+    def __hash__(self) -> int:
+        return hash(self.name)

doc/data/messages/e/eq-without-hash/good.py

@@ -0,0 +1,2 @@
+[MAIN]
+load-plugins=pylint.extensions.eq_without_hash,

doc/data/messages/e/eq-without-hash/pylintrc

@@ -0,0 +1,7 @@
+def say_hello(_new: str) -> str:  # [useless-param-doc]
+    """say hello!
+
+    :param _new:
+    :return: comment
+    """
+    return "hello"

doc/data/messages/u/useless-param-doc/bad.py

@@ -1 +1,6 @@
-# This is a placeholder for correct code for this message.
+def say_hello(_new: str) -> str:
+    """say hello!
+
+    :return: comment
+    """
+    return "hello"

doc/data/messages/u/useless-param-doc/details.rst

@@ -0,0 +1,2 @@
+[MAIN]
+load-plugins=pylint.extensions.docparams,

doc/data/messages/u/useless-param-doc/good.py

@@ -0,0 +1,8 @@
+def print_fruit(fruit, _):  # [useless-type-doc]
+    """docstring ...
+
+    Args:
+        fruit (str): A fruit.
+        _ (float): Another argument.
+    """
+    print(fruit)