add comment to mkmux function

diff --git a/src/bsv/actual_pinmux.py b/src/bsv/actual_pinmux.py
index bff3163012a1837aaf7d4849f8cd29984d3488a1..debd0152112dc7d5cc3de316a212aef1d66689ab 100644 (file)
--- a/src/bsv/actual_pinmux.py
+++ b/src/bsv/actual_pinmux.py
@@ -95,6 +95,10 @@ def mkcomment(ifaces, cell, idx, outenmode=False):
 
 
 def mkmux(p, ifaces, cell, suffix, outenmode):
+    """ creates a straight many-to-one muxer that accepts
+        multiple inputs and, based on an "address" routes
+        a given indexed input through to the (one) output
+    """
     comment = 'outen' if outenmode else 'output'
     fmtstr = "\t\t\twr%s==%d?%s:%s\n"  # mux-selector format
     ret = ''