fixup! First iteration of tree api

hackworthltd · Oct 20, 2021 · 776f221 · 776f221
1 parent 477fcd8
commit 776f221
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/primer/src/Primer/API.hs b/primer/src/Primer/API.hs
@@ -299,16 +299,18 @@ data APIProg = APIProg
 
 instance ToJSON APIProg
 
+-- | This type is the api's view of a 'Def'
+-- (this is expected to evolve as we flesh out the API)
 data APIDef = APIDef
   { id :: ID
   , name :: Name
   , _type :: Tree
   , term :: Tree
-  -- type and term: REVIEW: naming, what is the openapi.json like (esp _type),
-  -- should I force it to inline? (iirc, 'type' is a keyword both in Haskell
-  -- and TypeScript)
+  -- type and term: REVIEW: naming
+  -- (iirc, 'type' is a keyword both in Haskell and TypeScript)
   }
   deriving (Generic)
+
 instance ToJSON APIDef
 
 viewProg :: Prog -> APIProg