add more code-comments
authorLuke Kenneth Casson Leighton <lkcl@lkcl.net>
Mon, 25 Oct 2021 09:47:08 +0000 (10:47 +0100)
committerLuke Kenneth Casson Leighton <lkcl@lkcl.net>
Mon, 25 Oct 2021 09:47:08 +0000 (10:47 +0100)
src/ieee754/part/simd_scope.py

index 7daaa6ac23ba241a5ea74f9baa3c38a053b41781..d64a942dab74f3a9fb0272dac4d4feac87c6dbd3 100644 (file)
@@ -48,11 +48,13 @@ class SimdScope:
             FpElWid.BF16: 4,
         })
     * elwid: ElWid or nmigen Value with a shape of some ElWid class
-        the current elwid (simd element type)
+        the current elwid (simd element type).  example: Signal(2)
+        or Signal(IntElWid)
     """
 
     __SCOPE_STACK = []
 
+    # XXX REMOVE THIS FUNCTION.  ITS USE IS DANGEROUS.
     @classmethod
     def get(cls):
         """get the current SimdScope. raises a ValueError outside of any