add comment to eq function

diff --git a/src/add/example_buf_pipe.py b/src/add/example_buf_pipe.py
index 15d368c291d5a737c1b73c5a53bfa82c00ce09bb..60269c94d19c613e1786887a4916c18222c96903 100644 (file)
--- a/src/add/example_buf_pipe.py
+++ b/src/add/example_buf_pipe.py
@@ -99,6 +99,10 @@ class NextControl:
 
 
 def eq(o, i):
+    """ makes signals equal: a helper routine which identifies if it is being
+        passsed a list (or tuple) of objects, and calls the objects' eq
+        function.
+    """
     if not isinstance(o, Sequence):
         o, i = [o], [i]
     res = []