Updated module doc strings so they are only a single sentence and relocated print_time() function to utils.

philipstarkey · philipstarkey · commit 32b3d6ebb797 · 2024-01-27T16:15:18.000+11:00
diff --git a/labscript/compiler.py b/labscript/compiler.py
@@ -11,7 +11,7 @@
 #                                                                   #
 #####################################################################
 
-"""The labscript compiler interface. This is only relevant to developers and those
+"""The labscript compiler interface - this is only relevant to developers and those
 interested in the labscript interface to runmanager."""
 
 import builtins
diff --git a/labscript/core.py b/labscript/core.py
@@ -11,7 +11,7 @@
 #                                                                   #
 #####################################################################
 
-"""Core classes containing common device functionality. These are used in
+"""Core classes containing common device functionality - these are used in
 labscript-devices when adding support for a hardware device."""
 
 import sys
diff --git a/labscript/functions.py b/labscript/functions.py
@@ -11,24 +11,14 @@
 #                                                                   #
 #####################################################################
 
-"""Contains the functional forms of analog output ramps. These are not used directly,
+"""Contains the functional forms of analog output ramps - these are not used directly,
 instead see the interfaces in `AnalogQuantity`/`AnalogOut`."""
 
 from pylab import *
 import numpy as np
 
-def print_time(t, description):
-    """Print time with a descriptive string.
+from .utils import print_time
 
-    Useful debug tool to print time at a specific point
-    in the shot, during shot compilation. Helpful when
-    the time is calculated.
-
-    Args:
-        t (float): Time to print
-        description (str): Descriptive label to print with it
-    """
-    print('t = {0:.9f} s:'.format(t),description)
 
 def ramp(duration, initial, final):
     """Defines a linear ramp.
diff --git a/labscript/labscript.py b/labscript/labscript.py
@@ -11,7 +11,7 @@
 #                                                                   #
 #####################################################################
 
-"""Everything else including the `start()`, `stop()`, and `wait()` functions. All other
+"""Everything else including the `start()`, `stop()`, and `wait()` functions - all other
 classes are also imported here for backwards compatibility"""
 
 import builtins
diff --git a/labscript/utils.py b/labscript/utils.py
@@ -26,6 +26,20 @@
 cached_PseudoclockDevice = None
 
 
+def print_time(t, description):
+    """Print time with a descriptive string.
+
+    Useful debug tool to print time at a specific point
+    in the shot, during shot compilation. Helpful when
+    the time is calculated.
+
+    Args:
+        t (float): Time to print
+        description (str): Descriptive label to print with it
+    """
+    print(f"t={t:.9f}s: {description}")
+
+
 def is_remote_connection(connection):
     """Returns whether the connection is an instance of ``_RemoteConnection``
     
