Differences

This shows you the differences between two versions of the page.

--- codesnippets:codingconventions [2024/06/04 08:34] – [Module description] f2b216
+++ codesnippets:codingconventions [2025/10/08 00:48] (current) – external edit 127.0.0.1
@@ Line 446: / Line 446: @@
   * example: <code Haskell>
-class Show d => Format d where
+-- HUnit
-    {- |
+-- | ...capability to compare the expected value with the actual one,
-    * formated in a human readable pretty way, when printed to a text file or stream like _stdout_.
+-- |    and to display the difference if there is one.
+{-|
+-}
+class ( Show cmp ) => HUnit cmp where
+    -- equals
+    {- | ...compares the expected value with the actual one.
+    * result 'True' if both values are equal, otherwise 'False'
     -}
-    display
+    equals
-        -- | data to be formated in a pretty way
+        :: cmp      -- ^ actual value
-        :: d
+        -> cmp      -- ^ expected value
-        -- | formatted string representing the data
+        -> Bool     -- ^ 'True' when actual value and expected value is considered equal, otherwise 'False'
-        -> String
 </code>