Additional Haddocks for ConjMap methods

GaloisInc · Feb 5, 2025 · b0e5451 · b0e5451
1 parent d7c77f1
commit b0e5451
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/what4/src/What4/Expr/BoolMap.hs b/what4/src/What4/Expr/BoolMap.hs
@@ -242,6 +242,9 @@ viewConjMap =
   coerce @(BoolMap f -> BoolMapView f) @(ConjMap f -> ConjMapView f) viewBoolMap
 {-# INLINE viewConjMap #-}
 
+-- | Add a conjunct to a 'ConjMap'.
+--
+-- Wrapper around 'addVar'.
 addConjunct ::
   forall f.
   (HashableF f, OrdF f) =>
@@ -258,6 +261,8 @@ addConjunct =
     addVar
 {-# INLINE addConjunct #-}
 
+-- | Given the means to evaluate the conjuncts of a 'ConjMap' to a concrete
+-- 'Bool', evaluate the whole conjunction to a 'Bool'.
 evalConj :: Applicative m => (f BaseBoolType -> m Bool) -> ConjMap f -> m Bool
 evalConj f cm =
   let pol (x, Positive) = f x