Fix outdated comments and typos

Author: SkypLabs

examples/fsm_endpoint_1.py

@@ -8,13 +8,13 @@
 
     pip install python4yahdlc[examples]
 
-To create a virtual serial bus, you can use socat as followed:
+To create a virtual serial bus, you can use socat as follows:
 
 ::
 
     socat -d -d pty,raw,echo=0 pty,raw,echo=0
 
-Then, edit `ser.port` variable as needed.
+Then, edit `ser.port` accordingly.
 """
 
 import signal
@@ -26,7 +26,9 @@
 
 from yahdlc import FRAME_ACK, FRAME_DATA, FRAME_NACK, MessageError, frame_data, get_data
 
-# Serial port configuration.
+# -------------------------------------------------- #
+# Serial port configuration
+# -------------------------------------------------- #
 ser = serial.Serial()
 ser.port = "/dev/pts/5"
 ser.baudrate = 9600
@@ -97,9 +99,10 @@ def timeout_handler(signum, frame):
             signal.alarm(0)
             break
         except MessageError:
+            # No HDLC frame detected.
             pass
         except TimeoutError as err:
-            stderr.write("[x] " + str(err) + "\n")
+            stderr.write(f"[x] {str(err)}\n")
             e.fsm.timeout()
 
     if ftype not in (FRAME_ACK, FRAME_NACK):

examples/fsm_endpoint_2.py

@@ -8,13 +8,13 @@
 
     pip install python4yahdlc[examples]
 
-To create a virtual serial bus, you can use socat as followed:
+To create a virtual serial bus, you can use socat as follows:
 
 ::
 
     socat -d -d pty,raw,echo=0 pty,raw,echo=0
 
-Then, edit `ser.port` variable as needed.
+Then, edit `ser.port` accordingly.
 """
 
 from sys import stderr
@@ -33,7 +33,9 @@
     get_data,
 )
 
+# -------------------------------------------------- #
 # Serial port configuration
+# -------------------------------------------------- #
 ser = serial.Serial()
 ser.port = "/dev/pts/6"
 ser.baudrate = 9600
@@ -82,6 +84,7 @@ def wait_for_data(e):
             _, ftype, seq_no = get_data(ser.read(ser.in_waiting))
             break
         except MessageError:
+            # No HDLC frame detected.
             pass
         except FCSError:
             stderr.write("[x] Bad FCS\n")

examples/receive_data_frame.py

@@ -8,13 +8,13 @@
 
     pip install python4yahdlc[examples]
 
-To create a virtual serial bus, you can use socat as followed:
+To create a virtual serial bus, you can use socat as follows:
 
 ::
 
     socat -d -d pty,raw,echo=0 pty,raw,echo=0
 
-Then, edit `ser.port` variable as needed
+Then, edit `SERIAL_PORT` accordingly.
 """
 
 from sys import exit as sys_exit

examples/send_data_frame.py

@@ -8,13 +8,13 @@
 
     pip install python4yahdlc[examples]
 
-To create a virtual serial bus, you can use socat as followed:
+To create a virtual serial bus, you can use socat as follows:
 
 ::
 
     socat -d -d pty,raw,echo=0 pty,raw,echo=0
 
-Then, edit `ser.port` variable as needed.
+Then, edit `SERIAL_PORT` accordingly.
 """
 
 import signal

tests/integration/test_encode_decode.py

@@ -40,4 +40,5 @@ def test_decode_frame_byte_per_byte(self):
                 self.assertEqual(FRAME_DATA, ftype)
                 self.assertEqual(0, seq_no)
             except MessageError:
+                # No HDLC frame detected.
                 pass