Updated docstrings with new utility functions

Author: MrClock8163

src/geocompy/dna/__init__.py

@@ -58,28 +58,23 @@ class DNA(GsiOnlineProtocol):
 
     Opening a simple serial connection:
 
-    >>> from serial import Serial
-    >>> from geocompy.communication import SerialConnection
+    >>> from geocompy.communication import open_serial
     >>> from geocompy.dna import DNA
     >>>
-    >>> port = Serial("COM4", timeout=15)
-    >>> with SerialConnection(port) as line:
+    >>> with open_serial("COM1") as line:
     ...     dna = DNA(line)
     ...     dna.beep('SHORT')
     ...
     >>>
 
     Passing a logger:
 
-    >>> from logging import Logger, StreamHandler, DEBUG
-    >>> from serial import Serial
-    >>> from geocompy.communication import SerialConnection
+    >>> from logging import DEBUG
+    >>> from geocompy.communication import open_serial, get_logger
     >>> from geocompy.dna import DNA
     >>>
-    >>> log = Logger("stdout", DEBUG)
-    >>> log.addHandler(StreamHandler())
-    >>> port = Serial("COM4", timeout=15)
-    >>> with SerialConnection(port) as line:
+    >>> log = get_logger("DNA", "stdout", DEBUG)
+    >>> with open_serial("COM1") as line:
     ...     dna = DNA(line, log)
     ...     dna.beep('SHORT')
     ...

src/geocompy/tps1200p/__init__.py

@@ -73,28 +73,23 @@ class TPS1200P(GeoComProtocol):
 
     Opening a simple serial connection:
 
-    >>> from serial import Serial
-    >>> from geocompy.communication import SerialConnection
+    >>> from geocompy.communication import open_serial
     >>> from geocompy.tps1200p import TPS1200P
     >>>
-    >>> port = Serial("COM4", timeout=15)
-    >>> with SerialConnection(port) as line:
+    >>> with open_serial("COM1") as line:
     ...     tps = TPS1200P(line)
     ...     tps.com.nullproc()
     ...
     >>>
 
     Passing a logger:
 
-    >>> from logging import Logger, StreamHandler, DEBUG
-    >>> from serial import Serial
-    >>> from geocompy.communication import SerialConnection
+    >>> from logging import DEBUG
+    >>> from geocompy.communication import open_serial, get_logger
     >>> from geocompy.tps1200p import TPS1200P
     >>>
-    >>> log = Logger("stdout", DEBUG)
-    >>> log.addHandler(StreamHandler())
-    >>> port = Serial("COM4", timeout=15)
-    >>> with SerialConnection(port) as line:
+    >>> log = get_logger("Viva", "stdout", DEBUG)
+    >>> with open_serial("COM1") as line:
     ...     tps = TPS1200P(line, log)
     ...     tps.com.nullproc()
     ...

src/geocompy/vivatps/__init__.py

@@ -79,28 +79,23 @@ class VivaTPS(GeoComProtocol):
 
     Opening a simple serial connection:
 
-    >>> from serial import Serial
-    >>> from geocompy.communication import SerialConnection
+    >>> from geocompy.communication import open_serial
     >>> from geocompy.vivatps import VivaTPS
     >>>
-    >>> port = Serial("COM4", timeout=15)
-    >>> with SerialConnection(port) as line:
+    >>> with open_serial("COM1") as line:
     ...     tps = VivaTPS(line)
     ...     tps.com.nullproc()
     ...
     >>>
 
     Passing a logger:
 
-    >>> from logging import Logger, StreamHandler, DEBUG
-    >>> from serial import Serial
-    >>> from geocompy.communication import SerialConnection
+    >>> from logging import DEBUG
+    >>> from geocompy.communication import open_serial, get_logger
     >>> from geocompy.vivatps import VivaTPS
     >>>
-    >>> log = Logger("stdout", DEBUG)
-    >>> log.addHandler(StreamHandler())
-    >>> port = Serial("COM4", timeout=15)
-    >>> with SerialConnection(port) as line:
+    >>> log = get_logger("Viva", "stdout", DEBUG)
+    >>> with open_serial("COM1") as line:
     ...     tps = VivaTPS(line, log)
     ...     tps.com.nullproc()
     ...