Pylint, check method parameter documentation. (#909)

Clean docparam in examples.

Author: janiversen

doc/api/doxygen/build.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python3
+# pylint: disable=missing-type-doc
 """Doxygen API Builder."""
 import os
 import shutil

examples/common/callback_server.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python3
+# pylint: disable=missing-type-doc,missing-param-doc,differing-param-doc
 """Pymodbus Server With Callbacks.
 
 This is an example of adding callbacks to a running modbus server

examples/common/custom_datablock.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python3
+# pylint: disable=missing-type-doc,missing-param-doc,differing-param-doc
 """Pymodbus Server With Custom Datablock Side Effect.
 
 This is an example of performing custom logic after a value has been

examples/common/custom_message.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python3
+# pylint: disable=missing-type-doc
 """Pymodbus Synchronous Client Examples.
 
 The following is an example of how to use the synchronous modbus client

examples/common/custom_synchronous_server.py

@@ -60,8 +60,6 @@ def decode(self, data):
 # --------------------------------------------------------------------------- #
 # import the various server implementations
 # --------------------------------------------------------------------------- #
-from custom_message import CustomModbusRequest
-
 from pymodbus.version import version
 from pymodbus.server.sync import StartTcpServer
 from pymodbus.device import ModbusDeviceIdentification
@@ -70,6 +68,7 @@ def decode(self, data):
     ModbusSlaveContext,
     ModbusServerContext,
 )
+from .custom_message import CustomModbusRequest  # pylint: disable=relative-beyond-top-level
 
 # --------------------------------------------------------------------------- #
 # configure the service logging

examples/common/dbstore_update_server.py

@@ -1,3 +1,4 @@
+# pylint: disable=differing-param-doc,missing-any-param-doc
 """Pymodbus Server With Updating Thread.
 
 This is an example of having a background thread updating the

examples/common/performance.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python3
+# pylint: disable=missing-type-doc
 """Pymodbus Performance Example.
 
 The following is an quick performance check of the synchronous
@@ -52,8 +53,8 @@
 def single_client_test(n_host, n_cycles):
     """Perform a single threaded test of a synchronous client against the specified host
 
-    :param host: The host to connect to
-    :param cycles: The number of iterations to perform
+    :param n_host: The host to connect to
+    :param n_cycles: The number of iterations to perform
     """
     logger = log_to_stderr()
     logger.setLevel(logging.WARNING)

examples/common/updating_server.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python3
+# pylint: disable=missing-any-param-doc,differing-param-doc
 """Pymodbus Server With Updating Thread.
 
 This is an example of having a background thread updating the

examples/contrib/bcd_payload.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-type-doc,missing-param-doc,differing-param-doc,missing-raises-doc,missing-any-param-doc
 """Modbus BCD Payload Builder.
 
 This is an example of building a custom payload builder

examples/contrib/concurrent_client.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python3
+# pylint: disable=missing-type-doc,missing-param-doc,differing-param-doc
 """Concurrent Modbus Client.
 
 This is an example of writing a high performance modbus client that allows