From: Luke Kenneth Casson Leighton <lkcl@lkcl.net>
Date: Tue, 26 Jun 2018 06:44:50 +0000 (+0100)
Subject: add comment to mkmux function
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=da937976dc87c5c325c49ae54165d763d8c1c050;p=pinmux.git

add comment to mkmux function
---

diff --git a/src/bsv/actual_pinmux.py b/src/bsv/actual_pinmux.py
index bff3163..debd015 100644
--- 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 = ''