From 1ee71d265fc9a4c8a879a1950537faa8d2c6914c Mon Sep 17 00:00:00 2001
From: fanghr <chfanghr@gmail.com>
Date: Mon, 16 May 2022 23:11:13 +0800
Subject: [PATCH] add doc string for prop tests of utils

---
 agora-test/Spec/Utils.hs | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/agora-test/Spec/Utils.hs b/agora-test/Spec/Utils.hs
index 30c1dd7..6b71ff8 100644
--- a/agora-test/Spec/Utils.hs
+++ b/agora-test/Spec/Utils.hs
@@ -34,6 +34,7 @@ tests =
 
 --------------------------------------------------------------------------------
 
+-- | Yield true if 'Agora.Utils.pmsort' sorts a given list correctly.
 prop_msortSorted :: [Integer] -> Bool
 prop_msortSorted l = sorted == expected
   where
@@ -49,6 +50,7 @@ prop_msortSorted l = sorted == expected
     sorted :: [Integer]
     sorted = plift psorted
 
+-- | Yield true if 'Agora.Utils.pmerge' merges two list into a ordered list correctly.
 prop_mergeSorted :: [Integer] -> [Integer] -> Bool
 prop_mergeSorted a b = merged == expected
   where
@@ -75,6 +77,9 @@ prop_mergeSorted a b = merged == expected
     merged :: [Integer]
     merged = plift pmerged
 
+{- | Yield true if plutarch level 'Agora.Utils.phalve' splits a given list
+   as its haskell level counterpart does.
+-}
 prop_halveProperly :: [Integer] -> Bool
 prop_halveProperly l = halved == expected
   where
@@ -104,6 +109,9 @@ prop_halveProperly l = halved == expected
           s = plift $ pmatch phalved $ \(PPair _ x) -> x
        in (f, s)
 
+{- | Yield true if 'Agora.Utils.pnubSort' sorts and removes
+   duplicate elements from a given list.
+-}
 prop_nubSortProperly :: [Integer] -> Bool
 prop_nubSortProperly l = nubbed == expected
   where
@@ -119,6 +127,9 @@ prop_nubSortProperly l = nubbed == expected
     nubbed :: [Integer]
     nubbed = plift pnubbed
 
+{- | Yield true if 'Agora.Utils.isUnique' can correctly determine
+   whether a given list only contains unique elements or not.
+-}
 prop_uniqueList :: [Integer] -> Bool
 prop_uniqueList l = isUnique == expected
   where