From 7683ec29e9d84ee6526b623e8790d3372bf47807 Mon Sep 17 00:00:00 2001
From: Marcel Nijenhof <marceln@marceln.org>
Date: Fri, 5 Apr 2024 16:27:54 +0200
Subject: [PATCH] Cleanup of module  documentation

---
 src/lmwsip/__init__.py | 30 ++++++++++++++----------------
 1 file changed, 14 insertions(+), 16 deletions(-)

diff --git a/src/lmwsip/__init__.py b/src/lmwsip/__init__.py
index 0cda8dc..130e842 100644
--- a/src/lmwsip/__init__.py
+++ b/src/lmwsip/__init__.py
@@ -28,8 +28,6 @@ Support for:
     cmd(wn, vw, as)
 
 lmwParameters:
-
-Overzicht van de lmw parameters
  - Type: WN, VW, AS
  - Array size: [1-201]
  - Periode: 1, 10
@@ -600,7 +598,7 @@ Opens the connection and logs in.
                  "time_of_day": time.strftime("%H:%M", time.gmtime(now)) }
 
     def connect(self):
-        """connect()
+        """Setup the network connection
 
 connects to lmw with tcp using the values of the object creation.
 """
@@ -636,7 +634,7 @@ connects to lmw with tcp using the values of the object creation.
         self._socket = None
 
     def send(self, sipcmd):
-        """send(sipcmd)
+        """Send a sip command to the server
 
 send a sip command to the server
 """
@@ -666,7 +664,7 @@ send a sip command to the server
             raise LmwSipConnectError("LmwSip.telnetheader: Socket connection lost")
 
     def recv(self):
-        """recv()
+        """Recieve the results
 
 recieve a answer from the sip server
 """
@@ -709,7 +707,7 @@ recieve a answer from the sip server
         return(stringbuf)
 
     def login(self):
-        """login()
+        """Login the sip server
 
 Login lmw using the object creation user, password.
 Raises a LmwLoginFailure exception on failure
@@ -733,7 +731,7 @@ Raises a LmwLoginFailure exception on failure
         self.login()
 
     def reconnectcheck(self):
-        """reconnectcheck()
+        """Check if we need to reconnect.
 
 Checks if a reconnect is nessecery.
 
@@ -751,7 +749,7 @@ There are two timeouts:
             self.reconnect()
 
     def sendrecv(self, cmd):
-        """sendrecv(cmd)
+        """Send a a command and recieve the result.
 
 send the command and recieve the answer. 
 retry on socket failure.
@@ -780,7 +778,7 @@ retry on socket failure.
         return(ret)
 
     def ti(self):
-        """ti()
+        """Recieve the time from the sipserver.
 
 Request the time from lmw and returns the string.
 
@@ -792,7 +790,7 @@ Raises a LmwCmdWarn of failure
 
     def cmd(self, process, location, parameter, time_delta, day,
                                                 time_of_day, cmd_type="DATA"):
-        """cmd(process, location, parameter, time_delta, day, time_of_day)
+        """Create a sip command from the paramters
 
 Send a cmd to LMW and returns the lmw string
 
@@ -852,7 +850,7 @@ Returns:
 
     def valueStr(self, process, location, parameter, day = None,
                     time_of_day = None):
-        """value(process, location, parameter, [day], [time_of_day]):
+        """Get string of values from sip
 
 Parameters:
     process:      <WN|VW|AS>
@@ -879,7 +877,7 @@ Returns a single string value with quality
 
     def value(self, process, location, parameter, day = None,
                     time_of_day = None):
-        """value(process, location, parameter, [day], [time_of_day]):
+        """Get one value from sip
 
 Parameters:
     process:      <WN|VW|AS>
@@ -923,7 +921,7 @@ Returns a single string value or None
 
     def timeSerie(self, process, location, parameter,
                         startTime, endTime, cmd_type="DATB"):
-        """timeSerie(process, location, parameter, startTime, endTime, cmd_type="DATA")
+        """Get a python data structure with the results.
 
 Parameters:
     process:      <WN|VW|AS>
@@ -992,7 +990,7 @@ Errors:
         return(res)
 
     def logout(self):
-        """logout()
+        """Logut of the sip server,
 
 Logs of
 """
@@ -1016,7 +1014,7 @@ Note:
 """
 
     def __init__(self, start, delta, values=""):
-        """lmwTimeSerie(start, delta, values)
+        """lmwTimeSerie init
 
 Create a lmwTimeSerie object with:
     start:  Start time
@@ -1029,7 +1027,7 @@ Create a lmwTimeSerie object with:
             self.addvalues(start, values)
 
     def addvalues(self, start, values):
-        """addvalues(start, delta, values)
+        """Add values
 
 Add values to a timeserie
     start:  Start time