Browse Source

correct some doc-strings

Tobias Müller 6 years ago
parent
commit
500a77318a
1 changed files with 8 additions and 6 deletions
  1. 8 6
      Xcom-API/Xcom_API.py

+ 8 - 6
Xcom-API/Xcom_API.py

@@ -1280,6 +1280,7 @@ class Xcom_API():
         """
         ### Description:
         This method is used to decode Data from the received Byte-Frame, what you get from the xtender-system. 
+        If CRC-Check is active, it will check the byte-frame and raises a Value_Error, if a CRC-Error was detected. 
         It returns a List with the result of the returned Data and the Data itself.
 
         ### Arguments:
@@ -1314,8 +1315,8 @@ class Xcom_API():
         +-+-+
 
         ### Return-Value:
-        This Method return a **list** with two elements. The First is a **boolean** value, which is **False**, if the xtender-system detects an error and the second 
-        element of the **list** then contains the error-id. If no error occures, then the first element is **True** und the second element contains the answer of your request.
+        This Method return a **list** with two elements. The First is a **boolean** value, which is **True**, if the xtender-system detects an error and the second 
+        element of the **list** then contains the error-id. If no error occures, then the first element is **False** und the second element contains the answer of your request.
         The returned value of the second element is a **string**, **int** or **float**, depending of the service (read/write) of the request frame and of the 
         **<data_format>** argument.
 
@@ -1540,8 +1541,9 @@ class Xcom_API():
 
         """
         ### Description:
-        This method is used to decode Data from the received Byte-Frame, what you get from the xtender-system. It can only be used with a known Object_ID,
-        otherwise it will raise a Value_Error. It returns a List with the result of the returned Data and the Data itself.
+        This method is used to decode Data from the received Byte-Frame, what you get from the xtender-system. 
+        If CRC-Check is active, it will check the byte-frame and raises a Value_Error, if a CRC-Error was detected.
+        It can only be used with a known Object_ID, otherwise it will raise a Value_Error. It returns a List with the result of the returned Data and the Data itself.
 
         ### Arguments:
         The **<self>** argument is pointing to the object, which calls the method.
@@ -1549,8 +1551,8 @@ class Xcom_API():
         The **<bytearray_of_frame>** argument is the frame what you get, when you receive data from the serial port.
 
         ### Return-Value:
-        This Method return a **list** with two elements. The First is a **boolean** value, which is **False**, if the xtender-system detects an error and the second 
-        element of the **list** then contains the error-id. If no error occures, then the first element is **True** und the second element contains the answer of your request.
+        This Method return a **list** with two elements. The First is a **boolean** value, which is **True**, if the xtender-system detects an error and the second 
+        element of the **list** then contains the error-id. If no error occures, then the first element is **False** und the second element contains the answer of your request.
         The returned value of the second element is a **string**, **int** or **float**, depending of the service (read/write) of the request frame and of the 
         **<data_format>** argument.