whitespace cleanup and provide warning not to use Type (2) dsl.Module nmigen

language constructs in overrides of Type (1) AST language constructs

diff --git a/nmigen/hdl/ast.py b/nmigen/hdl/ast.py
index e47c83329dbbe06aea49bbd889bd338b08277aea..4c7ee4792268a6c9d277d38dbe72ee053c64eec7 100644 (file)
--- a/nmigen/hdl/ast.py
+++ b/nmigen/hdl/ast.py
@@ -151,20 +151,22 @@ class Value(metaclass=ABCMeta):
         super().__init__()
         self.src_loc = tracer.get_src_loc(1 + src_loc_at)
 
+    # These are redirection of "Type (1) - AST " nmigen language constructs
+    # If over-ridden to provide advanced behaviour, the implementation
+    # *MUST NOT* use "Type (2) - dsl.Module" nmigen language constructs
+    # (m.If, m.Else, m.Switch, m.FSM): it creates complications in dsl.Module.
+
     def __Repl__(self, count, *, src_loc_at=0):
         return _InternalRepl(self, count, src_loc_at=src_loc_at)
-
     def __Cat__(self, *args, src_loc_at=0):
         return _InternalCat(self, *args, src_loc_at=src_loc_at)
-
     def __Mux__(self, val1, val0):
         return _InternalMux(self, val1, val0)
-
-    def __Switch__(self, cases, *, src_loc=None, src_loc_at=0, case_src_locs={}):
+    def __Switch__(self, cases, *, src_loc=None, src_loc_at=0,
+                                   case_src_locs={}):
         return _InternalSwitch(self, cases, src_loc=src_loc,
                                src_loc_at=src_loc_at,
                                case_src_locs=case_src_locs)
-
     def __Assign__(self, rhs, *, src_loc_at=0):
         return _InternalAssign(self, rhs, src_loc_at=src_loc_at)