From: Luke Kenneth Casson Leighton <lkcl@lkcl.net>
Date: Mon, 25 Oct 2021 09:47:08 +0000 (+0100)
Subject: add more code-comments
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=86a8a2bd2eb7a4ebdc017f603ec4d05e5335f03a;p=ieee754fpu.git

add more code-comments
---

diff --git a/src/ieee754/part/simd_scope.py b/src/ieee754/part/simd_scope.py
index 7daaa6ac..d64a942d 100644
--- a/src/ieee754/part/simd_scope.py
+++ b/src/ieee754/part/simd_scope.py
@@ -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