Expose the Record type on the root funml package

docs/reference.md

@@ -2,6 +2,9 @@ FunML
 ===
 
 ::: funml
+    options:
+        filters:
+            - "!Record"
 
 Types
 ===

funml/__init__.py

@@ -28,7 +28,7 @@
     is_ok,
     is_some,
 )
-from .data.records import record, to_dict
+from .data.records import record, to_dict, Record
 from .data.lists import l, imap, ifilter, ireduce
 from .pipeline import execute
 
@@ -47,6 +47,7 @@
     "is_some",
     "is_none",
     "record",
+    "Record",
     "to_dict",
     "l",
     "imap",

funml/data/records.py

@@ -10,11 +10,11 @@ class Color:
         r: int
         g: int
         b: int
-        a: int
+        a: int = 1
 
     blue = Color(r=0, g=0, b=255, a=1)
     red = Color(r=255, g=0, b=0, a=1)
-    green = Color(r=0, g=255, b=0, a=1)
+    green = Color(r=0, g=255, b=0)
 
     print(blue)
     # prints: {'r': 0, 'g': 0, 'b': 255, 'a': 1}
@@ -120,6 +120,21 @@ class Record(types.MLType):
     the expected attributes and then is used to create new instances
     of that record type.
 
+    This type is usually not used directly but rather we use the [@record](funml.record) decorator
+
+    Example:
+
+        ```python
+        import funml as ml
+
+        @ml.record
+        class Color:
+            r: int
+            g: int
+            b: int
+            a: int = 1
+        ```
+
     Args:
         kwargs: the data for the current record instance.