add docstring Mul8_16_32_64 only for testing
authorLuke Kenneth Casson Leighton <lkcl@lkcl.net>
Mon, 26 Aug 2019 12:23:35 +0000 (13:23 +0100)
committerLuke Kenneth Casson Leighton <lkcl@lkcl.net>
Mon, 26 Aug 2019 12:23:35 +0000 (13:23 +0100)
src/ieee754/part_mul_add/multiply.py

index 89e4c4d322782ff1e16b2e88646405d6dcce0bd3..215d18c6a1aacce049dd74c6331437c2e74e5853 100644 (file)
@@ -1312,6 +1312,8 @@ class Intermediates(PipeModBase):
 class Mul8_16_32_64(Elaboratable):
     """Signed/Unsigned 8/16/32/64-bit partitioned integer multiplier.
 
+    XXX NOTE: this class is intended for unit test purposes ONLY.
+
     Supports partitioning into any combination of 8, 16, 32, and 64-bit
     partitions on naturally-aligned boundaries. Supports the operation being
     set for each partition independently.