Add module docstring

bessman · bessman · commit f847af6774c3 · 2020-10-07T08:48:40.000+02:00
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -74,7 +74,7 @@ def record_traffic(log: list, logfile: str):
         elif direction == b"RX":
             rx[-1] += list(data)
         else:
-            raise ValueError("Unknown direction: {direction}")
+            raise ValueError(f"Unknown direction: {direction}")
 
     print([tx, rx])
     json.dump([tx, rx], open(logfile, "w"))
diff --git a/tests/test_oscilloscope.py b/tests/test_oscilloscope.py
@@ -1,3 +1,10 @@
+"""Tests for PSL.oscilloscope.
+
+When integration testing, the PSLab's analog output is used to generate a signal
+which is sampled by the oscilloscope. Before running the integration tests,
+connect SI1->CH1->CH2->CH3.
+"""
+
 import numpy as np
 import pytest
 from scipy.optimize import curve_fit
@@ -24,7 +31,7 @@ def scope(handler):
         psl = sciencelab.connect()
         psl.H.disconnect()
         psl.H = handler
-        psl.set_sine1(1000)
+        psl.set_sine1(FREQUENCY)
         handler._logging = True
     return oscilloscope.Oscilloscope(handler)
 
