Add documentation comment for hashNamesFromList

tweag · Mar 19, 2024 · 9245dc6 · 9245dc6
1 parent 312d084
commit 9245dc6
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/Cooked/Pretty/Options.hs b/src/Cooked/Pretty/Options.hs
@@ -106,5 +106,7 @@ defaultHashNames =
       (permanentCurrencySymbol, "Permanent")
     ]
 
+-- | Smart constructor for maps to be used in the "pcOptHashNames"
+-- pretty-printing option.
 hashNamesFromList :: (Hashable a) => [(a, String)] -> Map Pl.BuiltinByteString String
 hashNamesFromList = Map.fromList . map (first toHash)