add FPNum comment

diff --git a/src/add/nmigen_add_experiment.py b/src/add/nmigen_add_experiment.py
index bbadfc0e0417d01ea77e593b956ce131187fb8b2..68d15bd4f536af17060da80b9ecaeee296f95a9b 100644 (file)
--- a/src/add/nmigen_add_experiment.py
+++ b/src/add/nmigen_add_experiment.py
@@ -7,6 +7,12 @@ from nmigen.cli import main
 
 
 class FPNum:
+    """ Floating-point Number Class, variable-width TODO (currently 32-bit)
+        Contains signals for an incoming copy of the value, decoded into
+        sign / exponent / mantissa.
+        Also contains encoding functions, creation and recognition of
+        zero, NaN and inf (all signed)
+    """
     def __init__(self, width, m_width=None):
         self.width = width
         if m_width is None: