add some more comments/FIXMEs

guida-lang · Dec 8, 2024 · 3d6aa22 · 3d6aa22
1 parent 5acef0b
commit 3d6aa22
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 4 deletions.
diff --git a/src/Compiler/Elm/Package.elm b/src/Compiler/Elm/Package.elm
@@ -40,8 +40,11 @@ import Json.Encode as Encode
 -- PACKAGE NAMES
 
 
+{-| This has been simplified from `Name Author Project` as part of the work for
+`System.TypeCheck.IO`.
+-}
 type alias Name =
-    ( String, String )
+    ( Author, Project )
 
 
 toString : Name -> String

diff --git a/src/System/TypeCheck/IO.elm b/src/System/TypeCheck/IO.elm
@@ -178,26 +178,34 @@ sequenceAList =
 
 
 
--- Point (Compiler.Type.UnionFind)
+-- POINT
 
 
+{-| FIXME Compiler.Type.UnionFind
+-}
 type Point
     = Pt Int
 
 
+{-| FIXME Compiler.Type.UnionFind
+-}
 type PointInfo
     = Info Int Int
     | Link Point
 
 
 
--- DESCRIPTORS (Compiler.Type.Type)
+-- DESCRIPTORS
 
 
+{-| FIXME Compiler.Type.Type
+-}
 type Descriptor
     = Descriptor Content Int Mark (Maybe Variable)
 
 
+{-| FIXME Compiler.Type.Type
+-}
 type Content
     = FlexVar (Maybe String)
     | FlexSuper SuperType (Maybe String)
@@ -208,6 +216,8 @@ type Content
     | Error
 
 
+{-| FIXME Compiler.Type.Type
+-}
 type SuperType
     = Number
     | Comparable
@@ -219,6 +229,8 @@ type SuperType
 -- MARKS
 
 
+{-| FIXME Compiler.Type.Type
+-}
 type Mark
     = Mark Int
 
@@ -227,10 +239,14 @@ type Mark
 -- TYPE PRIMITIVES
 
 
+{-| FIXME Compiler.Type.Type
+-}
 type alias Variable =
     Point
 
 
+{-| FIXME Compiler.Type.Type
+-}
 type FlatType
     = App1 Canonical String (List Variable)
     | Fun1 Variable Variable
@@ -241,8 +257,10 @@ type FlatType
 
 
 
--- CANONICAL (Compiler.Elm.ModuleName)
+-- CANONICAL
 
 
+{-| FIXME Compiler.Elm.ModuleName
+-}
 type Canonical
     = Canonical ( String, String ) String