SIENTIAPDE-1081

Enhance documentation across multiple modules with detailed parameter descriptions and usage examples

laborious/activities/opc.py

@@ -39,6 +39,17 @@ class OPC(BaseActivity):
 
     def write_data(self, server: str, tag: str, data: Any,
                    data_type: str, tag_type: str):
+        """
+        Write data to OPC server.
+
+        Args:
+            - server (str): The name of the OPC server.
+            - tag (str): The tag to write to.
+            - data (Any): The data to write.
+            - data_type (str): The data type.
+            - tag_type (str): The tag type.
+        """
+
         try:
             self.opc_repository[server].write_data(
                 tag, data, data_type)
@@ -61,15 +72,14 @@ class OPC(BaseActivity):
         operations are optional and independent of each other.
 
         Args:
-            input_data (dict[str, Any]): The input data. Contains the following keys:
-                - data (dict[str, Any]): The dataframe that contains the data to write
+            - input_data(dict[str, Any]): The input data. Contains the following keys:
+                - data(dict[str, Any]): The dataframe that contains the data to write
                 to the OPC servers.
-                - opc_output_config (dict[str, Any]): The OPC writing configuration.
+                - opc_output_config(dict[str, Any]): The OPC writing configuration.
                 The keys are the OPC server names and the values contain:
-                    prediction_tags (dict[str, Any]): The tags to write to the OPC servers.
-                    confidence_tags (dict[str, Any]): The tags to write to the OPC servers.
+                    - prediction_tags(dict[str, Any]): The tags to write to the OPC servers.
+                    - confidence_tags(dict[str, Any]): The tags to write to the OPC servers.
 
-        Returns:
         """
         self.logger.debug("Writing data to OPC servers...")
         data = DataFrame(input_data['data'])