Minor adjustments to slcan

hardbyte · hardbyte · commit ba5d714c99b7 · 2018-01-14T17:26:35.000+11:00
diff --git a/can/interfaces/slcan.py b/can/interfaces/slcan.py
@@ -1,6 +1,7 @@
 """
 Interface for slcan compatible interfaces (win32/linux).
-(Linux could use slcand/socketcan as well).
+
+Note Linux users can use slcand/socketcan as well.
 """
 
 from __future__ import absolute_import
@@ -15,6 +16,7 @@
 
 logger = logging.getLogger(__name__)
 
+
 class slcanBus(BusABC):
     """
     slcan interface
@@ -73,15 +75,13 @@ def __init__(self, channel, ttyBaudrate=115200, timeout=1, bitrate=None, **kwarg
         self.serialPort = io.TextIOWrapper(io.BufferedRWPair(self.serialPortOrig, self.serialPortOrig, 1),
                                            newline='\r', line_buffering=True)
 
-        # why do we sleep here?
         time.sleep(self._SLEEP_AFTER_SERIAL_OPEN)
 
         if bitrate is not None:
             self.close()
             if bitrate in self._BITRATES:
                 self.write(self._BITRATES[bitrate])
             else:
-                # this only prints the keys of the dict
                 raise ValueError("Invalid bitrate, choose one of " + (', '.join(self._BITRATES)) + '.')
 
         self.open()
@@ -93,27 +93,31 @@ def recv(self, timeout=None):
 
         canId = None
         remote = False
+        extended = False
         frame = []
         readStr = self.serialPort.readline()
-        if not readStr: # if not None and not empty
+        if not readStr:
             return None
         else:
-            if readStr[0] == 'T':   # extended frame
+            if readStr[0] == 'T':
+                # extended frame
                 canId = int(readStr[1:9], 16)
                 dlc = int(readStr[9])
                 extended = True
                 for i in range(0, dlc):
                     frame.append(int(readStr[10 + i * 2:12 + i * 2], 16))
-            elif readStr[0] == 't': # normal frame
+            elif readStr[0] == 't':
+                # normal frame
                 canId = int(readStr[1:4], 16)
                 dlc = int(readStr[4])
                 for i in range(0, dlc):
                     frame.append(int(readStr[5 + i * 2:7 + i * 2], 16))
-                extended = False
-            elif readStr[0] == 'r': # remote frame
+            elif readStr[0] == 'r':
+                # remote frame
                 canId = int(readStr[1:4], 16)
                 remote = True
-            elif readStr[0] == 'R': # remote extended frame
+            elif readStr[0] == 'R':
+                # remote extended frame
                 canId = int(readStr[1:9], 16)
                 extended = True
                 remote = True
diff --git a/doc/interfaces/slcan.rst b/doc/interfaces/slcan.rst
@@ -20,4 +20,4 @@ Bus
 Internals
 ---------
 
-.. TODO:: Implement and document slcan interface.
+.. TODO:: Document internals of slcan interface.
diff --git a/doc/interfaces/socketcan_native.rst b/doc/interfaces/socketcan_native.rst
@@ -3,7 +3,7 @@ SocketCAN (python)
 
 Python 3.3 added support for socketcan for linux systems.
 
-The socketcan_native interface directly uses Python's socket module to 
+The ``socketcan_native`` interface directly uses Python's socket module to
 access SocketCAN on linux. This is the most direct route to the kernel
 and should provide the most responsive one.
 
