From: Luke Kenneth Casson Leighton <lkcl@lkcl.net>
Date: Mon, 26 Aug 2019 12:23:35 +0000 (+0100)
Subject: add docstring Mul8_16_32_64 only for testing
X-Git-Tag: ls180-24jan2020~362
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=674602ad56ad774971c0ce95a878028b65dc176b;p=ieee754fpu.git

add docstring Mul8_16_32_64 only for testing
---

diff --git a/src/ieee754/part_mul_add/multiply.py b/src/ieee754/part_mul_add/multiply.py
index 89e4c4d3..215d18c6 100644
--- a/src/ieee754/part_mul_add/multiply.py
+++ b/src/ieee754/part_mul_add/multiply.py
@@ -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.